BigCommerce · Example Payload

Bigcommerce Createcoupon Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Createcoupon 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": "createCoupon",
  "method": "POST",
  "path": "/coupons",
  "summary": "BigCommerce Create a New Coupon",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "201",
      "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"
      }
    }
  ]
}