POST Orders/OrderConfiguration

OrderConfigurations where a OrderConfiguration

Request Information

URI Parameters

None.

Body Parameters

GetOrderConfigurationRequest
NameDescriptionTypeAdditional information
ID

integer

None.

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:
<GetOrderConfigurationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Order">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">3</StoreID>
  <ID>1</ID>
</GetOrderConfigurationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderConfiguration
NameDescriptionTypeAdditional information
ID

integer

None.

NextOrderNumber

string

None.

AdministrationEmail

Email account to receive automated logistics-related reports from the system

string

String length: inclusive between 0 and 100

CancelUnpaidOrdersAutomatically

If true, unpaid orders automatically get cancelled after PaymentDue date

boolean

None.

FinishOnShipping

If true, orders get automatically finished when Shipping orders switch to Shipping status

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "NextOrderNumber": "sample string 2",
  "AdministrationEmail": "sample string 3",
  "CancelUnpaidOrdersAutomatically": true,
  "FinishOnShipping": true
}

application/xml, text/xml

Sample:
<OrderConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Order">
  <AdministrationEmail>sample string 3</AdministrationEmail>
  <CancelUnpaidOrdersAutomatically>true</CancelUnpaidOrdersAutomatically>
  <FinishOnShipping>true</FinishOnShipping>
  <ID>1</ID>
  <NextOrderNumber>sample string 2</NextOrderNumber>
</OrderConfiguration>