Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Use this method to add a new store to a Customer in Komet Sales.

Tip

Valid Tokens: Company.

Filter by label (Content by label)
showLabelsfalse
max5
sorttitle
titleRelated Articles
cqllabel in ( "customer-setup" , "ship-to" )
labelsship-to customer-setup ship-to

Request


URL: https://api.kometsales.com/api/customer.shipto.add

Method: POST

Content-Type: application/JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


customerId (required) (integer:20)

Customer ID.

You can get this value from the customer.list API method.


name (required)(string:200)

Ship-To name.


address (optional)(string:200)

Shipping address street.


city (optional)(string:50)

Shipping address city.


state (optional)(string:50)

Shipping address state.


zipcode (optional)(string:10)

Shipping address Zip Code.


country (optional)(string:50)

Shipping address Country.


phone (optional)(string:20)

Phone number.


fax (optional)(string:20)

Fax number.


carrierId (optional) (integer:20)

Carrier ID.

You can get this value from the carrier.list API method.


carrierAccount (optional)(string:20)

The Carrier account number.


salesPersonCodeForFlowers (optional)(string:20)

Salesperson code for flower-type products. 

You can find the salesperson code in Setup > Settings. To learn more, read Sales Codes.


salesPersonCodeForPlants (optional)(string:20)

.Salesperson code for plant-type products. 

You can find the salesperson code in Setup > Settings. To learn more, read Sales Codes.


Code Block
{
    "authenticationToken": "token_info_goes_here", 
    "customerId":6326, 
    "name":"Store miami",
    "city":"miami", 
    "state":"FL", 
    "country":"United States", 
    "zipcode":"568722", 
    "address":"Stree 123 Suite 2", 
    "fax": "786 3434 23232", 
    "phone": "661 522 3154"
  }

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


shipToId (integer:20)

Internal Ship-To ID.


Code Block
{
  "status": 1,
  "message": "Ship to was successfully saved",
  "shipToId": 20131
 }
We've encountered an issue exporting this macro. Please try exporting this page again later.