Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This method allows you to update an existing customer ship to in Komet Sales.

Request

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

Method: POST

Content-Type: application/json

Input Parameters

  • authenticationToken (required)(string:50): Komet Sales security token.

  • shipToId (required) (integer:20): Ship To ID that you want to update. You can obtain this value from the customer.shipto.list API method.

  • customerId (required) (integer:20): customer ID. You can obtain this value from the customer.list API method.

  • name (optional)(string:200): name of the Ship To.

  • address (optional)(string:200): Shipping Street address.

  • city (optional)(string:50): Shipping City name.

  • state (optional)(string:50): Shipping State name.

  • zipcode (optional)(string:10): Shipping Zip/Postal Code.

  • country (optional)(string:50): Shipping Country name.

  • phone (optional)(string:20): phone number.

  • fax (optional)(string:20): fax number.

  • carrierId (optional) (integer:20) : carrier ID. You can obtain this value from the carrier.list API method.

  • carrierAccount (optional)(string:20): carrier account number.

  • salesPersonCodeForFlowers (optional)(string:20): Code of the salesperson when the type of product is flowers. 

  • salesPersonCodeForPlants (optional)(string:20): Code of the salesperson when the type of product is plants.  

Sample Request

{
    "authenticationToken": "token_info_goes_here", 
    "shipToId": 20131,
    "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

Output

  • status (integer:1): transaction status. 1 for success or 0 for failure.

  • message (string:500): description of the status of the transaction.

  • shipToId (integer:20): Ship To internal ID that was just updated.

Sample Response

{
  "status": 1,
  "message": "Ship to was successfully saved",
  "shipToId": 20131
 }


  • No labels