POST Orders/Orders
Request Information
URI Parameters
None.
Body Parameters
OrdersRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerID | string |
Required String length: inclusive between 0 and 128 |
|
| Filter | Filter |
None. |
|
| Range | FilterRange |
Required |
|
| Lang | string |
None. |
|
| StoreID | integer |
None. |
Request 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.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
OrdersView| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| Orders | Collection of BareOrder |
None. |
|
| FilterableProperties | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"Orders": [
{
"CustomerFullName": "sample string 1",
"ID": 1,
"Number": "sample string 2",
"Created": "2024-04-01T06:17:20.0947689+02:00",
"Modified": "2024-04-01T06:17:20.0947689+02:00",
"Confirmed": "2024-04-01T06:17:20.0947689+02:00",
"Paid": "2024-04-01T06:17:20.0947689+02:00",
"Finished": "2024-04-01T06:17:20.0947689+02:00",
"Cancelled": "2024-04-01T06:17:20.0947689+02:00",
"PaymentDue": "2024-04-01T06:17:20.0947689+02:00",
"ExternalID": "sample string 5",
"PaymentProcessorOrderID": "sample string 6",
"Token": "74dcf238-ca4c-431a-b9fd-64f774d0fa45",
"CustomerID": "sample string 8",
"InvoiceRequired": true,
"StoreID": 10,
"TariffID": 11,
"StatusID": 12,
"PublicStatusID": 1,
"ShippingPolicyID": 13,
"Observations": "sample string 14",
"Price": {
"PaymentMeansBase": 1.0,
"CouponsBase": 2.0,
"PointsBase": 3.0,
"ItemsBase": 4.0,
"ShippingsBase": 5.0,
"Base": 6.0,
"Tax": 7.0,
"EquivalenceSurcharge": 8.0,
"Discount": 9.0,
"SubTotal": 10.0,
"Amount": 11.0
},
"Points": {
"Redeemed": 1,
"Rewarded": 2,
"Rewarding": 3
}
},
{
"CustomerFullName": "sample string 1",
"ID": 1,
"Number": "sample string 2",
"Created": "2024-04-01T06:17:20.0947689+02:00",
"Modified": "2024-04-01T06:17:20.0947689+02:00",
"Confirmed": "2024-04-01T06:17:20.0947689+02:00",
"Paid": "2024-04-01T06:17:20.0947689+02:00",
"Finished": "2024-04-01T06:17:20.0947689+02:00",
"Cancelled": "2024-04-01T06:17:20.0947689+02:00",
"PaymentDue": "2024-04-01T06:17:20.0947689+02:00",
"ExternalID": "sample string 5",
"PaymentProcessorOrderID": "sample string 6",
"Token": "74dcf238-ca4c-431a-b9fd-64f774d0fa45",
"CustomerID": "sample string 8",
"InvoiceRequired": true,
"StoreID": 10,
"TariffID": 11,
"StatusID": 12,
"PublicStatusID": 1,
"ShippingPolicyID": 13,
"Observations": "sample string 14",
"Price": {
"PaymentMeansBase": 1.0,
"CouponsBase": 2.0,
"PointsBase": 3.0,
"ItemsBase": 4.0,
"ShippingsBase": 5.0,
"Base": 6.0,
"Tax": 7.0,
"EquivalenceSurcharge": 8.0,
"Discount": 9.0,
"SubTotal": 10.0,
"Amount": 11.0
},
"Points": {
"Redeemed": 1,
"Rewarded": 2,
"Rewarding": 3
}
}
],
"FilterableProperties": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<OrdersView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Order">
<FilterableProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Services.Views">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</FilterableProperties>
<Orders>
<BareOrder>
<Cancelled>2024-04-01T06:17:20.0947689+02:00</Cancelled>
<Confirmed>2024-04-01T06:17:20.0947689+02:00</Confirmed>
<Created>2024-04-01T06:17:20.0947689+02:00</Created>
<CustomerFullName>sample string 1</CustomerFullName>
<CustomerID>sample string 8</CustomerID>
<ExternalID>sample string 5</ExternalID>
<Finished>2024-04-01T06:17:20.0947689+02:00</Finished>
<ID>1</ID>
<InvoiceRequired>true</InvoiceRequired>
<Modified>2024-04-01T06:17:20.0947689+02:00</Modified>
<Number>sample string 2</Number>
<Observations>sample string 14</Observations>
<Paid>2024-04-01T06:17:20.0947689+02:00</Paid>
<PaymentDue>2024-04-01T06:17:20.0947689+02:00</PaymentDue>
<PaymentProcessorOrderID>sample string 6</PaymentProcessorOrderID>
<Points>
<Redeemed>1</Redeemed>
<Rewarded>2</Rewarded>
<Rewarding>3</Rewarding>
</Points>
<Price>
<Amount xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">11</Amount>
<Base xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">6</Base>
<Discount xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">9</Discount>
<EquivalenceSurcharge xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">8</EquivalenceSurcharge>
<ItemsBase xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">4</ItemsBase>
<ShippingsBase xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">5</ShippingsBase>
<SubTotal xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">10</SubTotal>
<Tax xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">7</Tax>
<CouponsBase>2</CouponsBase>
<PaymentMeansBase>1</PaymentMeansBase>
<PointsBase>3</PointsBase>
</Price>
<PublicStatusID>1</PublicStatusID>
<ShippingPolicyID>13</ShippingPolicyID>
<StatusID>12</StatusID>
<StoreID>10</StoreID>
<TariffID>11</TariffID>
<Token>74dcf238-ca4c-431a-b9fd-64f774d0fa45</Token>
</BareOrder>
<BareOrder>
<Cancelled>2024-04-01T06:17:20.0947689+02:00</Cancelled>
<Confirmed>2024-04-01T06:17:20.0947689+02:00</Confirmed>
<Created>2024-04-01T06:17:20.0947689+02:00</Created>
<CustomerFullName>sample string 1</CustomerFullName>
<CustomerID>sample string 8</CustomerID>
<ExternalID>sample string 5</ExternalID>
<Finished>2024-04-01T06:17:20.0947689+02:00</Finished>
<ID>1</ID>
<InvoiceRequired>true</InvoiceRequired>
<Modified>2024-04-01T06:17:20.0947689+02:00</Modified>
<Number>sample string 2</Number>
<Observations>sample string 14</Observations>
<Paid>2024-04-01T06:17:20.0947689+02:00</Paid>
<PaymentDue>2024-04-01T06:17:20.0947689+02:00</PaymentDue>
<PaymentProcessorOrderID>sample string 6</PaymentProcessorOrderID>
<Points>
<Redeemed>1</Redeemed>
<Rewarded>2</Rewarded>
<Rewarding>3</Rewarding>
</Points>
<Price>
<Amount xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">11</Amount>
<Base xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">6</Base>
<Discount xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">9</Discount>
<EquivalenceSurcharge xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">8</EquivalenceSurcharge>
<ItemsBase xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">4</ItemsBase>
<ShippingsBase xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">5</ShippingsBase>
<SubTotal xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">10</SubTotal>
<Tax xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Order">7</Tax>
<CouponsBase>2</CouponsBase>
<PaymentMeansBase>1</PaymentMeansBase>
<PointsBase>3</PointsBase>
</Price>
<PublicStatusID>1</PublicStatusID>
<ShippingPolicyID>13</ShippingPolicyID>
<StatusID>12</StatusID>
<StoreID>10</StoreID>
<TariffID>11</TariffID>
<Token>74dcf238-ca4c-431a-b9fd-64f774d0fa45</Token>
</BareOrder>
</Orders>
<TotalCount>1</TotalCount>
</OrdersView>