BigCommerce · Example Payload

Bigcommerce Getgiftcertificates Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Getgiftcertificates 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": "getGiftCertificates",
  "method": "GET",
  "path": "/gift_certificates",
  "summary": "BigCommerce Get All Gift Certificates",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": 24,
          "code": "10R-5E2-BO4-RWT",
          "amount": "1000.0000",
          "status": "active",
          "balance": "500.0000",
          "to_name": "Alyss",
          "order_id": 1281,
          "template": "celebration.html",
          "message": "Celebrate",
          "to_email": "test@test.com",
          "from_name": "Noland",
          "from_email": "test1@test.com",
          "customer_id": 0,
          "expiry_date": "Mon, 2 Jan 2023 08:45:38 CST",
          "purchase_date": "Tue, 20 Jan 1970 08:45:38 CST",
          "currency_code": "USD"
        },
        {
          "id": 25,
          "code": "10R-6E3-AO4-RST",
          "amount": "700.0000",
          "status": "active",
          "balance": "700.0000",
          "to_name": "Alyss",
          "order_id": 0,
          "template": "general.html",
          "message": "Test",
          "to_email": "test@test.com",
          "from_name": "Noland",
          "from_email": "test1@test.com",
          "customer_id": 0,
          "expiry_date": "Mon, 2 Jan 2023 08:45:38 CST",
          "purchase_date": "Tue, 20 Jan 1970 08:45:38 CST",
          "currency_code": "USD"
        },
        {
          "id": 27,
          "code": "15R-6E3-AO4-RST",
          "amount": "50.0000",
          "status": "active",
          "balance": "50.0000",
          "to_name": "Lyss",
          "order_id": 0,
          "template": "celebration.html",
          "message": "Celebrate",
          "to_email": "test5@test.com",
          "from_name": "Somethingelse",
          "from_email": "test15@test.com",
          "customer_id": 0,
          "expiry_date": "Mon, 2 Jan 2023 08:45:38 CST",
          "purchase_date": "Tue, 20 Jan 1970 08:45:38 CST",
          "currency_code": "USD"
        }
      ]
    }
  ]
}