PUT Orders/ModifyOrder

Request Information

URI Parameters

None.

Body Parameters

OrderBinding
NameDescriptionTypeAdditional information
ID

integer

None.

StoreID

integer

None.

CustomerID

string

Required

String length: inclusive between 0 and 128

PaymentMeansID

integer

None.

ShippingPolicyID

integer

None.

PublicStatusID

integer

None.

StatusID

integer

None.

InvoiceRequired

Set true when customer explicitely requires an Invoice for this order

boolean

None.

NotifyExternalPlatform

Triggers a synchronization of this order with an external platform like ERP software

boolean

None.

Points

integer

None.

Observations

Customer observations

string

String length: inclusive between 0 and 200

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "StoreID": 2,
  "CustomerID": "sample string 3",
  "PaymentMeansID": 4,
  "ShippingPolicyID": 5,
  "PublicStatusID": 1,
  "StatusID": 6,
  "InvoiceRequired": true,
  "NotifyExternalPlatform": true,
  "Points": 1,
  "Observations": "sample string 9"
}

application/xml, text/xml

Sample:
<OrderBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Order">
  <CustomerID>sample string 3</CustomerID>
  <ID>1</ID>
  <InvoiceRequired>true</InvoiceRequired>
  <NotifyExternalPlatform>true</NotifyExternalPlatform>
  <Observations>sample string 9</Observations>
  <PaymentMeansID>4</PaymentMeansID>
  <Points>1</Points>
  <PublicStatusID>1</PublicStatusID>
  <ShippingPolicyID>5</ShippingPolicyID>
  <StatusID>6</StatusID>
  <StoreID>2</StoreID>
</OrderBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.