Discount Rebate List

GET 
/openapi/2022-01/discount_rebates

Retrieves a list of rebate discounts available for a shop.

Request

Query Parameters

limit int32

Limit per page

page int32

Page number

need_detail_url boolean

details url return in responses

Responses

200

200

application/json

Schema

Schema

pageinteger
Default value: 0
Example: 1
limitinteger
Default value: 0
Example: 20
totalstring
Example: 1
data object[]
Array [
allocation_limitstring
Example: 0
allocation_limit_amountstring
Example: 0.0000
allocation_methodstring
Example: across
customer_selectionstring
Example: all
detail_urlstring
Example: tzt.myshoplaza.com/promotions/rebate/47d2a827-e914-49e0-a14c-3161edb1ae9e
discount_typestring
Example: fixed_amount
ends_atstring
Example: -1
entitled_filter_idsarray
entitled_filter_listarray
entitled_product_idsarray
global_show_textstring
Example: close
idstring
Example: 47d2a827-e914-49e0-a14c-3161edb1ae9e
once_per_customerstring
Example: 0
popups_idstring
Example:
popups_settingstring
Example: close
prerequisitestring
Example: 1
prerequisite_customer_idsarray
prerequisite_customer_range
prerequisite_customer_segment_idsarray
prerequisite_quantity_range
prerequisite_subtotal_range object[]
Array [
greater_than_or_equal_tostring
Example: 123
valuestring
Example: 1
value_event_typestring
Example:
value_conditionstring
Example: less_than_or_equal_to
target_typestring
Example:
target_dataarray
target_data_variantarray
target_data_collectionarray
]
prerequisite_threshold_quantity_range
prerequisite_threshold_subtotal_range
product_num
progressstring
Example: ongoing
sortstring
Example: {"by":"title","direction":"asc"}
starts_atstring
Example: 1682652084
statusstring
Example: 1
target_price_typestring
Example: combined_price
target_selectionstring
Example: all
target_typestring
Example:
times_usedstring
Example: 0
titlestring
Example: tzt-满减活动-吸引客户购买更多
usage_limitstring
Example: 0
valueinteger
Default value: 0
Example: 0
value_typestring
Example: fixed_amount
variant_product_idsarray
]

Example

{
  "page": 1,
  "limit": 20,
  "total": "1",
  "data": [
    {
      "allocation_limit": "0",
      "allocation_limit_amount": "0.0000",
      "allocation_method": "across",
      "customer_selection": "all",
      "detail_url": "tzt.myshoplaza.com/promotions/rebate/47d2a827-e914-49e0-a14c-3161edb1ae9e",
      "discount_type": "fixed_amount",
      "ends_at": "-1",
      "entitled_filter_ids": [
        null
      ],
      "entitled_filter_list": [
        null
      ],
      "entitled_product_ids": [
        null
      ],
      "global_show_text": "close",
      "id": "47d2a827-e914-49e0-a14c-3161edb1ae9e",
      "once_per_customer": "0",
      "popups_id": "",
      "popups_setting": "close",
      "prerequisite": "1",
      "prerequisite_customer_ids": [
        null
      ],
      "prerequisite_customer_range": {},
      "prerequisite_customer_segment_ids": [
        null
      ],
      "prerequisite_quantity_range": {},
      "prerequisite_subtotal_range": [
        {
          "greater_than_or_equal_to": "123",
          "value": "1",
          "value_event_type": "",
          "value_condition": "less_than_or_equal_to",
          "target_type": "",
          "target_data": [
            null
          ],
          "target_data_variant": [
            null
          ],
          "target_data_collection": [
            null
          ]
        }
      ],
      "prerequisite_threshold_quantity_range": {},
      "prerequisite_threshold_subtotal_range": {},
      "product_num": {},
      "progress": "ongoing",
      "sort": "{\"by\":\"title\",\"direction\":\"asc\"}",
      "starts_at": "1682652084",
      "status": "1",
      "target_price_type": "combined_price",
      "target_selection": "all",
      "target_type": "",
      "times_used": "0",
      "title": "tzt-满减活动-吸引客户购买更多",
      "usage_limit": "0",
      "value": 0,
      "value_type": "fixed_amount",
      "variant_product_ids": [
        null
      ]
    }
  ]
}

Result

{
  "page": 1,
  "limit": 20,
  "total": "1",
  "data": [
    {
      "allocation_limit": "0",
      "allocation_limit_amount": "0.0000",
      "allocation_method": "across",
      "customer_selection": "all",
      "detail_url": "tzt.myshoplaza.com/promotions/rebate/47d2a827-e914-49e0-a14c-3161edb1ae9e",
      "discount_type": "fixed_amount",
      "ends_at": "-1",
      "entitled_filter_ids": [],
      "entitled_filter_list": [],
      "entitled_product_ids": [],
      "global_show_text": "close",
      "id": "47d2a827-e914-49e0-a14c-3161edb1ae9e",
      "once_per_customer": "0",
      "popups_id": "",
      "popups_setting": "close",
      "prerequisite": "1",
      "prerequisite_customer_ids": [],
      "prerequisite_customer_range": null,
      "prerequisite_customer_segment_ids": [],
      "prerequisite_quantity_range": null,
      "prerequisite_subtotal_range": [
        {
          "greater_than_or_equal_to": "123",
          "value": "1",
          "value_event_type": "",
          "value_condition": "less_than_or_equal_to",
          "target_type": "",
          "target_data": [],
          "target_data_variant": [],
          "target_data_collection": []
        }
      ],
      "prerequisite_threshold_quantity_range": null,
      "prerequisite_threshold_subtotal_range": null,
      "product_num": null,
      "progress": "ongoing",
      "sort": "{\"by\":\"title\",\"direction\":\"asc\"}",
      "starts_at": "1682652084",
      "status": "1",
      "target_price_type": "combined_price",
      "target_selection": "all",
      "target_type": "",
      "times_used": "0",
      "title": "tzt-满减活动-吸引客户购买更多",
      "usage_limit": "0",
      "value": 0,
      "value_type": "fixed_amount",
      "variant_product_ids": []
    }
  ]
}

400

400

application/json

No schema