Update Order

Overview

In order to update an existing Order, you can consume the endpoint presented in this article. In order to consume it, you must:

  • Be authenticated user

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed to the service call.

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/Orders/{id}​​

For your server endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/Orders/{id}

Request

Information about expected request parameters can be found on swagger UI https://tt.api.sellercloud.com/rest/swagger.

  • Method Type: HttpPut
  • Authorization: Use Bearer Token (where ‘Token’ is the token received from token authentication)
  • Header info: Content-Type: application/json
  • Parameters: ID of existing Order
  • Request Body:

ParameterData TypeDescriptionIs Required
CompanyIdintegerOrder company ID.

Do not provide or set to “null” if no update is needed.

false
CustomerIdintegerOrder customer ID.

Do not provide or set to “null” if no update is needed.

false
OrderSourceenumOrder source (channel). Possible values can be found here.

Do not provide or set to “null” if no update is needed.

false
OrderSubTypeenumOrder sub type. Possible values can be found here.

Do not provide or set to “null” if no update is needed.

false
SalesRep1integerFirst sales rep ID.

Do not provide or set to “null” if no update is needed.

false
CurrencyCodeenumOrder currency code.

Do not provide or set to “null” if no update is needed.

false
DisableInventoryCountboolSpecifies if inventory count is disabled for the order.

Do not provide or set to “null” if no update is needed.

false
ShippingAddressaddressOrder shipping address.

Do not provide or set to “null” if no update is needed.

NOTE: When address is provided all of its information has to be passed because a full address update is done.

false
BillingAddressaddressOrder billing address.

Do not provide or set to “null” if no update is needed.

NOTE: When address is provided all of its information has to be passed because a full address update is done.

false
=============
Address.FirstNamestringAddress first nametrue
Address.MiddleNamestringAddress middle namefalse
Address.LastNamestringAddress last nametrue
Address.ZipCodestringAddress zip codetrue
Address.CitystringAddress citytrue
Address.CountrystringAddress two letter country code.true
Address.BusinessstringAddress business namefalse
Address.AddressLine1stringAddress line 1true
Address.AddressLine2stringAddress line 2false
Address.FaxstringAddress faxfalse
Address.RegionstringAddress regionfalse
Address.StatestringAddress state/province two letter code. Required when country is seto to “US” or “CA”.false
Address.PhonestringAddress phonefalse

Response

  • If user is authenticated and Order update is successful, then response will be Status Code 200 => OK
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • If there are missing or invalid values in the request, then reponse will be Status Code 400 => Bad Request
  • In case of error, response will be Status Code 500 => Internal Server Error

Was this article helpful?

Next
Get Saved Views