Overview


This method returns a list of Ship To for a given customer.

 


Request

https://api.kometsales.com/api/customer.shipto.list

  • Method: GET
  • Content-Type: URL Params.

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • customerId (optional)(integer:20): Komet Sales internal customer ID. You can obtain this value from the customer.list API method.
  • name (optional)(string:200): name of the Ship To.
  • updateAsOf (optional) (date) (date format YYYY-MM-DD): the last updating date of the ship to's as of the system will search.

    Important

    Users must send either the customerId, name, or the updatedAsOf as input parameter.

Filtering by name uses a "LIKE" expression. Filters are not case sensitive.

https://api.kometsales.com/api/customer.shipto.list?authenticationToken=token_info_goes_here&customerId=6236

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • shiptos: array of Ship To of the customer.
    • id (integer:20): Komet Sales internal Ship To customer ID.
    • name (string:200): name of the Ship To.
    • address (string:200): address of the Ship To.
    • city (string:200): name of the city of the Ship To.
    • state (string:200): name of the state of the Ship To.
    • zipcode (string:10): zip code of the Ship To.
    • country (string:200): name of the country of the Ship To.
    • phone (string:50): phone number of the Ship To.
    • fax (string:50): fax number of the Ship To.
    • carrierId (integer:20) : Komet Sales internal carrier ID.
    • carrierName (string:200): name of default carrier of the Ship To.
    • carrierAccount (string:50): carrier account.
    • carrierCode (string:10): code of the carrier.
    • updatedAsOf (optional) (date) (date format YYYY-MM-DD): last updating date of the ship to.
    • customerId (integer:20): Komet Sales internal customer ID.
    • customerName (string:200): name of the customer.