Update Order

We will make a POST request from eCommerce Webship to the endpoint you specify in your Update Order URL field which should mark orders as shipped so that they don't show up in the future calls to the GET URL. Requests to this URL will have an http content type of "application/x-www-form-urlencoded".

REST Endpoint

POST [/your-custom-get-order-endpoint]

Explanation of Request Fields

Field	Type	Description
orderId	string	Order id to update
carrier	string	"ups" or "usps" or "dhl" or "fedex"
trackingNumbers	string	Comma separated list of tracking numbers
items	Form encoded list	List of items
item.id	string	Product id
item.quantity	string	Product quantity (or partial quantity if lesser quantity is selected through the user interface)
receiver	Form encoded key value pairs	receiver address
receiver.company	string	Receiver company name
receiver.name	string	Receiver name
receiver.address1	string	First line of Receiver address
receiver.address2	string	Second line of Receiver address
receiver.city	string	Receiver city
receiver.state	string	Receiver state
receiver.zip	string	Receiver zip code
receiver.country	string	Two character country code
receiver.phone	string	Ten digit phone number
receiver.email	string	Receiver Email
quote	Form encoded key value pairs	Quote
quote.charges	Form encoded list	List of charges
quote.charges.base	string	Base charge amount
quote.charges.surcharges	string	Surcharges total charge amount
quote.charges.total	string	Total charges amount including base and surcharges
quote.surcharges	Form encoded list	List of surcharges
quote.surcharges.code	string	Internal surcharge code
quote.surcharges.charge	string	Surcharge amount
quote.surcharges.description	string	Surcharge description
quote.details	Form encoded key value pairs	Quote details
quote.details.quotedWeightType	string	Quoted weight type
quote.details.quotedWeightUnit	string	Weight unit
quote.details.quotedWeight	string	Weight amount
quote.zone	string	Receiver zone
quote.totalTransitDays	string	Number of days in transit
quote.notices	string	List of notices
billingInfo	Form encoded key value pairs	Billing party info
billingInfo.party	string	Billing party (sender, receiver, thirdParty)
billingInfo.country	string	Billing party country
billingInfo.account	string	Billing party account number
billingInfo.zip	string	Billing party account zip

Expected Response Status Code

200 OK

Request POST Body Example

(without newlines)

orderId=12345
&carrier=ups
&trackingNumbers=AAAA,BBBB,CCCC
&items[0][id]=1234
&items[0][quantity]=2
&items[1][id]=4321
&items[1][quantity]=1
&receiver[company]=Rocksolid+Internet
&receiver[name]=Al+Borland
&receiver[address1]=1880+FooBar+Dr
&receiver[address2]=
&receiver[city]=La+Cucaracha
&receiver[state]=California
&receiver[zip]=91711
&receiver[country]=US
&receiver[phone]=8888881234
&receiver[email]=foo@bar.com