DELETE Logistics/RemoveShippingOrder
Removes an existing ShippingOrder.
Request Information
URI Parameters
None.
Body Parameters
ShippingOrderBinding| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| StatusID |
System managed status |
integer |
None. |
| Expiration |
This shipping order is kept in Reserved status till Expiration date. tbd: remove shippingorders after expiration |
date |
None. |
| WarehouseID |
the warehouse this shipping order belongs to |
integer |
None. |
| PublicStatusID |
Store-admin managed status. Visible to customers |
integer |
None. |
| Packages |
Number of packages used for this shipping |
integer |
None. |
| Weight |
Kilograms of freight |
decimal number |
None. |
| CarrierID |
Carrier used for this shipping. By default, the one related to the related shippingmeans. But, it could be modified by the warehouse staff. |
integer |
None. |
| CarrierShippingIdentifier |
Identifier used by the carrier for this shipping |
string |
None. |
| NotifyCarrier |
Triggers a notification to the carrier |
boolean |
None. |
| OrderID | integer |
None. |
|
| Lang | string |
None. |
|
| StoreID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": 1,
"StatusID": 2,
"Expiration": "2025-12-06T05:42:10.6361355+01:00",
"WarehouseID": 3,
"PublicStatusID": 1,
"Packages": 4,
"Weight": 5.0,
"CarrierID": 1,
"CarrierShippingIdentifier": "sample string 6",
"NotifyCarrier": true,
"OrderID": 8,
"Lang": "sample string 9",
"StoreID": 10
}
application/xml, text/xml
Sample:
<ShippingOrderBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Logistics"> <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 9</Lang> <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">10</StoreID> <OrderID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Order">8</OrderID> <CarrierID>1</CarrierID> <CarrierShippingIdentifier>sample string 6</CarrierShippingIdentifier> <Expiration>2025-12-06T05:42:10.6361355+01:00</Expiration> <ID>1</ID> <NotifyCarrier>true</NotifyCarrier> <Packages>4</Packages> <PublicStatusID>1</PublicStatusID> <StatusID>2</StatusID> <WarehouseID>3</WarehouseID> <Weight>5</Weight> </ShippingOrderBinding>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.