| Excerpt | ||
|---|---|---|
Use this method to get a list of Ship-To’s of a given Customer.
|
When using this method keep the following information in mind:
You must send at least one of these parameters:
customerId,name, orupdatedAsOf.Filtering by
nameuses a "LIKE" expression.Filters are not case-sensitive.
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/customer.shipto.list
Method: GET
Content-Type: URL Parameters
Input parameters
authenticationToken (required)(string:50)
Komet Sales security token.
customerId (optional)(integer:20)
Komet Sales internal customer ID.
You can get this value from the customer.list API method.
id (optional) (integer: 20)
Komet Sales internal Ship-To ID.
name (optional)(string:200)
Ship-To name.
updateAsOf (optional) (date)
The date when the Ship-To was last updated.
Date format: YYYY-MM-DD
| Code Block | ||
|---|---|---|
| ||
https://api.kometsales.com/api/customer.shipto.list?authenticationToken=token_info_goes_here&customerId=6236 |
Response
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
shiptos (array)
An array containing the Customer’s of Ship-To’s.
id (integer:20)
Komet Sales internal Ship-To ID.
shipToCode (string:50)
Ship-To Code.
name (string:200)
Ship-To name.
address (string:200)
Ship-To address street.
city (string:200)
Ship-To address city.
state (string:200)
Ship-To address State name.
zipcode (string:10)
Ship-To address zip code.
country (string:200)
Ship-To address country.
phone (string:50)
Ship-To phone number.
fax (string:50)
Ship-To fax number.
carrierId (integer:20)
Komet Sales internal Carrier ID.
carrierName (string:200)
Ship-To default Carrier name.
carrierAccount (string:50)
Carrier account.
carrierCode (string:10)
Carrier code.
updatedAsOf (optional) (date)
The date when the Ship-To was last updated.
Date format: YYYY-MM-DD
customerId (integer:20)
Komet Sales internal customer ID.
customerName (string:200)
Customer’s name.
| Code Block |
|---|
{
"status": "1",
"message": "OK",
"shiptos":
[
{
"id": 23423,
“ShipToCode”:”MIA3”,
"name": "Store 1",
"address": "Street 23 Ave 2",
"city": "Miami",
"state": "FL",
"zipcode": "22333",
"country": "USA",
"carrierId": 908990,
"carrierName": "Armellini",
"carrierAccount": "F00000"
}
,
{
"id": 23455,
“ShipToCode”:”MIA9”,
"name": "Store 2",
"address": "Street 24 Ave 2",
"city": "Miami Dade",
"state": "FL",
"zipcode": "20000",
"country": "USA",
"phone":"786 000 0000",
"carrierId": 908991,
"carrierName": "Prime",
"carrierAccount": "000"
}
]
} |