/api/v1/orders/{orderId}

patch

https://dogfood.commerce.insitesandbox.com/api/v1/orders/{orderId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orderId

string

required

Body Params

uri

string

erpOrderNumber

string

webOrderNumber

string

orderDate

date-time

status

string

statusDisplay

string

customerNumber

string

customerSequence

string

customerPO

string

currencyCode

string

currencySymbol

string

terms

string

shipCode

string

salesperson

string

btCompanyName

string

btAddress1

string

btAddress2

string

btAddress3

string

btAddress4

string

billToCity

string

billToState

string

billToPostalCode

string

btCountry

string

stCompanyName

string

stAddress1

string

stAddress2

string

stAddress3

string

stAddress4

string

shipToCity

string

shipToState

string

shipToPostalCode

string

stCountry

string

notes

string

productTotal

number

orderSubTotal

number

orderDiscountAmount

number

productDiscountAmount

number

shippingCharges

number

handlingCharges

number

otherCharges

number

taxAmount

number

orderTotal

number

modifyDate

date-time

requestedDeliveryDateDisplay

date-time

orderLines

array of objects

orderLines

orderPromotions

array of objects

orderPromotions

shipmentPackages

array of objects

shipmentPackages

returnReasons

array of strings

returnReasons

orderHistoryTaxes

array of objects

orderHistoryTaxes

productTotalDisplay

string

orderSubTotalDisplay

string

orderTotalDisplay

string

orderGrandTotalDisplay

string

orderDiscountAmountDisplay

string

productDiscountAmountDisplay

string

taxAmountDisplay

string

totalTaxDisplay

string

shippingAndHandlingDisplay

string

shippingChargesDisplay

string

handlingChargesDisplay

string

otherChargesDisplay

string

canAddToCart

boolean

canAddAllToCart

boolean

showTaxAndShipping

boolean

shipViaDescription

string

fulfillmentMethod

string

customerVatNumber

string

vmiLocationId

string

vmiLocationName

string

properties

object

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/html

200OK