BigCommerce · Example Payload

Bigcommerce Createcustomers Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Createcustomers 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": "createCustomers",
  "method": "POST",
  "path": "/customers",
  "summary": "BigCommerce Create Customers",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "example-1",
      "example": [
        {
          "email": "string@example.com",
          "first_name": "string",
          "last_name": "string",
          "company": "string",
          "phone": "string",
          "notes": "string",
          "tax_exempt_category": "string",
          "customer_group_id": 0,
          "addresses": [
            {
              "address1": "Addr 1",
              "address2": "",
              "address_type": "residential",
              "city": "San Francisco",
              "company": "History",
              "country_code": "US",
              "first_name": "Ronald",
              "last_name": "Swimmer",
              "phone": "707070707",
              "postal_code": "33333",
              "state_or_province": "California",
              "form_fields": [
                {
                  "name": "test",
                  "value": "test"
                }
              ]
            }
          ],
          "authentication": {
            "force_password_reset": true,
            "new_password": "string123"
          },
          "accepts_product_review_abandoned_cart_emails": true,
          "store_credit_amounts": [
            {
              "amount": 43.15
            }
          ],
          "origin_channel_id": 1,
          "channel_ids": [
            1
          ],
          "form_fields": [
            {
              "name": "test",
              "value": "test"
            }
          ]
        }
      ]
    }
  ],
  "responseExamples": [
    {
      "status": "422",
      "contentType": "application/json",
      "name": "response",
      "example": {
        "status": 422,
        "title": "Create customers failed.",
        "type": "/api-docs/getting-started/api-status-codes",
        "errors": {
          ".customer_create": "Error creating customers"
        }
      }
    }
  ]
}