BigCommerce · Example Payload

Bigcommerce Getcoupons Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Getcoupons Example is an example object payload from BigCommerce, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "getCoupons",
  "method": "GET",
  "path": "/coupons",
  "summary": "BigCommerce Get All Coupons",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": 1,
          "name": "$5 off",
          "type": "per_total_discount",
          "amount": "5.0000",
          "min_purchase": "0.0000",
          "expires": "",
          "enabled": true,
          "code": "S2549JM0Y",
          "applies_to": {
            "entity": "categories",
            "ids": [
              0
            ]
          },
          "num_uses": 2,
          "max_uses": 0,
          "max_uses_per_customer": 0,
          "restricted_to": {},
          "shipping_methods": [],
          "date_created": "Tue, 13 Mar 2018 16:18:59 +0000"
        },
        {
          "id": 2,
          "name": "Limit by Location",
          "type": "per_total_discount",
          "amount": "5.0000",
          "min_purchase": "25.0000",
          "expires": "",
          "enabled": true,
          "code": "E3JC79S0I",
          "applies_to": {
            "entity": "categories",
            "ids": [
              0
            ]
          },
          "num_uses": 0,
          "max_uses": 25,
          "max_uses_per_customer": 0,
          "restricted_to": {
            "countries": "AU"
          },
          "shipping_methods": [
            "shipping_endicia"
          ],
          "date_created": "Tue, 12 Jun 2018 20:22:19 +0000"
        }
      ]
    }
  ]
}