POST Orders/Order

Request Information

URI Parameters

None.

Body Parameters

OrderRequest
NameDescriptionTypeAdditional information
OrderID

integer

None.

Token

globally unique identifier

None.

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "OrderID": 1,
  "Token": "3471ace1-6765-435d-a743-673a3eb58c8b",
  "Lang": "sample string 3",
  "StoreID": 4
}

application/xml, text/xml

Sample:
<OrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Order">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">sample string 3</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">4</StoreID>
  <OrderID>1</OrderID>
  <Token>3471ace1-6765-435d-a743-673a3eb58c8b</Token>
</OrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Order
NameDescriptionTypeAdditional information
ID

integer

None.

Number

string

None.

Created

date

None.

Modified

date

None.

Confirmed

date

None.

Paid

date

None.

Finished

date

None.

Cancelled

date

None.

PaymentDue

date

None.

CustomerID

string

None.

Token

globally unique identifier

None.

Base

decimal number

None.

Tax

decimal number

None.

Discount

decimal number

None.

Amount

decimal number

None.

MetricValue

decimal number

None.

NormalizationFactor

decimal number

None.

EquivalenceSurcharge

decimal number

None.

Status

OrderStatus

None.

PublicStatus

OrderPublicStatus

None.

BillingContact

OrderBillingContact

None.

ShippingPolicy

ShippingPolicy

None.

Items

Collection of OrderItem

None.

OrderShippings

Collection of OrderShipping

None.

OrderPaymentMeans

OrderPaymentMeans

None.

InvoiceRequired

boolean

None.

Coupons

Collection of Coupon

None.

Points

OrderPoints

None.

Price

OrderPriceBreakdownView

None.

Observations

string

None.

PromotedItems

boolean

None.

Annotations

Collection of OrderAnnotation

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.