BigCommerce · Example Payload

Bigcommerce Validatecustomercredentials Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Validatecustomercredentials 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": "validateCustomerCredentials",
  "method": "POST",
  "path": "/customers/validate-credentials",
  "summary": "BigCommerce Validate a customer credentials",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "data",
      "example": {
        "email": "foo@bar.com",
        "password": "password",
        "channel_id": 1
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "data",
      "example": {
        "is_valid": true,
        "customer_id": 1
      }
    },
    {
      "status": "429",
      "contentType": "application/json",
      "name": "response",
      "example": {
        "status": 429,
        "title": "Too many requests",
        "type": "/api-docs/getting-started/api-status-codes",
        "errors": {}
      }
    }
  ]
}