v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Customer Service

getAllCustomers

Retrieve a list of customer account details. Retrieve one customer's account details using customerAccountNumber and customerCode.

get/customer/v1/getAllCustomers

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.

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

Example response

[
  {
    "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"
      }
    ]
  }
]