getCustomersByPage

get https://webservices-test.net-chef.com/customer/v1/getCustomersByPage

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

Query Params

activeFlag

boolean

Use true to retrieve only active Customers.

customerAccountNumber

string

The Account Number associated with the Customer.

customerCode

string

The Code that identifies the Customer in Crunchtime.

locationCode

string

The Code that identifies the Location in Crunchtime.

pageNumber

int32

Defaults to 1

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

pageSize

int32

Number of items to display per page.

includeNull

boolean

Specify 'true' to output null data elements.

Headers

authenticationtoken

string

required

Secure token for API authentication.

password

string

required

Password for the Crunchtime Application User.

sitename

string

required

Crunchtime site identifier. (test or production)

userid

string

required

User ID for the Crunchtime Application User.

X-B3-TraceId

string

Optional trace identifier for troubleshooting.

Responses

Response body

object

customerDetails

array of objects

customerDetails

object

customerDetailDetails

array of objects

customerDetailDetails

object

activeFlag

string

"activeFlag" from Customer

address1

string

required

"address1" from Customer

address2

string

"address2" from Customer

city

string

required

"city" from Customer

country

string

required

"country" from Customer

customerAccountNumber

string

"customerAccountNumber" from Customer

customerCode

string

required

"customerCode" from Customer

customerName

string

required

"customerName" from Customer

exportCode

string

"exportCode" from Customer

importCode

string

"importCode" from Customer

locationCode

string

required

"locationCode" from Customer

retailPricing

string

"retailPricing" from Customer

state

string

"state" from Customer

supplyPricing

string

required

"supplyPricing" from Customer

zipcode

string

"zipcode" from Customer

hasNext

boolean

totalPages

int32

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://webservices-test.net-chef.com/customer/v1/getCustomersByPage?pageNumber=1' \
3
     --header 'accept: application/json'


xxxxxxxxxx
27
}
1
{
2
  "customerDetails": [
3
    {
4
      "customerDetailDetails": [
5
        {
6
          "activeFlag": "Y",
7
          "address1": "100 Main Street1",
8
          "address2": "100 Main Street2",
9
          "city": "BOSTON",
10
          "country": "USA",
11
          "customerAccountNumber": "860 536-4589 428",
12
          "customerCode": "030292",
13
          "customerName": "Melissa's Vendor",
14
          "exportCode": "EXP1",
15
          "importCode": "new_imp_code1",
16
          "locationCode": 123456,
17
          "retailPricing": "STAN",
18
          "state": "IN",
19
          "supplyPricing": "COST PLUS",
20
          "zipcode": "02114"
21
        }
22
      ]
23
    }
24
  ],
25
  "hasNext": true,

200Success

400Validation Error

401Authorization

404customers not found

500Unexpected Error

504Timeout