Sign in
Customer Service

getCustomersByPage

Retrieve customer account details by pageNumber. Use to retrieve data in smaller chunks.

get/customer/v1/getCustomersByPage

Query parameters

activeFlagboolean

Use true to retrieve only active Customers.

customerAccountNumberstring

The Account Number associated with the Customer.

customerCodestring

The Code that identifies the Customer in Crunchtime.

locationCodestring

The Code that identifies the Location in Crunchtime.

pageNumberinteger

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.

pageSizeinteger

Number of items to display per page.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

hasNextboolean
totalPagesinteger

Example response

{
  "customerDetails": [
    {
      "customerDetailDetails": [
        {
          "activeFlag": "Y",
          "address1": "100 Main Street1",
          "address2": "100 Main Street2",
          "city": "BOSTON",
          "country": "USA",
          "customerAccountNumber": "860 536-4589 428",
          "customerCode": "030292",
          "customerName": "Melissa's Vendor",
          "exportCode": "EXP1",
          "importCode": "new_imp_code1",
          "retailPricing": "STAN",
          "state": "IN",
          "supplyPricing": "COST PLUS",
          "zipcode": "02114"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.