Versions Compared

Old Version 1

changes.mady.by.user Andres Toledo

Saved on

compared with

New Version 2

changes.mady.by.user Andres Toledo

Saved on

Key

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

This Use this method allows you to update an existing customer ship to Customer Ship-To in Komet Sales.

Tip

Valid Tokens: Company.

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

Request

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

Method: POST

Content-Type: application/

json

JSON

Input Parameters

authenticationToken 

authenticationToken (required)(string:50)

:

Komet Sales security token.

shipToId 

shipToId (required) (integer:20)

:

Ship-To ID

that you want to update

.

You can

obtain

get this value from the customer.shipto.list API method.

customerId 

customerId (required) (integer:20)

: customer

Customer ID.

You can

obtain

get this value from the customer.list API method.

name (optional)(string:200)

: name of the

Ship-To name.

address (optional)(string:200)

:

Shipping

Street

address street.

city (optional)(string:50)

:

Shipping

City name

address city.

state (optional)(string:50)

:

Shipping

State name

address state.

zipcode (optional)(string:10)

: Shipping Zip/Postal Code

Shipping address zip code.

country (optional)(string:50)

:

Shipping

Country name

address country.

phone (optional)(string:20)

: phone

Phone number.

fax (optional)(string:20)

: fax

Fax number.

carrierId (optional) (integer:20)

: carrier

Carrier ID.

You can

obtain

get this value from the carrier.list API method.

carrierAccount (optional)(string:20)

: carrier

Carrier account number.

salesPersonCodeForFlowers (optional)(string:20)

: Code of the salesperson when the type of product is flowers

Salesperson code for flower-type products. 

salesPersonCodeForPlants (optional)(string:20)

: Code of the salesperson when the type of product is plants.  

Sample Request

Salesperson code for plant-type products.

Code Block
{
    "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

Transaction status. 1

for success or 0 for failure.

= Success | 0 = Failure

message (string:500)

: description of the status of the transaction

Transaction status description.

shipToId (integer:20)

: Ship To internal ID that was just updated.

Sample Response

Internal Ship-to ID.

Code Block
{
  "status": 1,
  "message": "Ship to was successfully saved",
  "shipToId": 20131
 }
Panel
titleRelated Articles
Filter by label (Content by label)showLabelsfalsemax10showSpacefalsesorttitlecqllabel in ( "customer-setup" , "ship-to" )labelsship-to customer-setup