POST Orders/OrderShipping

GetOrderShippings

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
OrderID	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<GetOrderShippingRequest 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 3</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">4</StoreID>
  <OrderID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Order">2</OrderID>
  <ID>1</ID>
</GetOrderShippingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderShipping

Name	Description	Type	Additional information
ID		integer	None.
OrderID		integer	None.
Created		date	None.
Modified		date	None.
DeliveryDate		date	None.
DeliveryDays		decimal number	None.
ShippingMeansID		integer	None.
ShippingMeans		ShippingMeans	None.
Contact		OrderShippingContact	None.
Items		Collection of OrderShippingItem	None.
ApplicableMeans		Collection of OrderShippingMeans	None.
PickUpWarehouseID	Warehouse for CustomerPickUp, if provided contact is ignored	integer	None.
TaxRateID		integer	None.
Price		PriceBreakdown	None.
Observations	Customer observations	string	None.
Appointments		Collection of ShippingAppointment	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "OrderID": 2,
  "Created": "2025-12-06T05:41:55.0940195+01:00",
  "Modified": "2025-12-06T05:41:55.0940195+01:00",
  "DeliveryDate": "2025-12-06T05:41:55.0940195+01:00",
  "DeliveryDays": 6.0,
  "ShippingMeansID": 7,
  "ShippingMeans": {
    "ID": 1,
    "CarrierID": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "PrivateObservations": "sample string 4",
    "Disabled": "2025-12-06T05:41:55.0940195+01:00",
    "BaseID": 5,
    "CustomerPickUp": true,
    "TaxRateID": 7,
    "IsExpress": true
  },
  "Contact": {
    "ID": 1,
    "Email": "sample string 2",
    "Phone": "sample string 3",
    "Alias": "sample string 4",
    "Name": "sample string 5",
    "Surnames": "sample string 6",
    "VatIdentifier": "sample string 7",
    "WebURL": "sample string 8",
    "Addressee": "sample string 9",
    "Street": "sample string 10",
    "PostalCode": "sample string 11",
    "Place": {
      "ID": 1,
      "Name": "sample string 2",
      "PostalCode": "sample string 3",
      "LocalityID": 4
    },
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "Code": "sample string 3"
    }
  },
  "Items": [
    {
      "ID": 1,
      "Quantity": 2.0,
      "VariationID": 3,
      "OrderItemID": 4
    },
    {
      "ID": 1,
      "Quantity": 2.0,
      "VariationID": 3,
      "OrderItemID": 4
    }
  ],
  "ApplicableMeans": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "Carrier": {
        "ID": 1,
        "Name": "sample string 2",
        "ProcessorTypeID": 1,
        "ProcessorEntityID": 1
      },
      "Amount": 3.0,
      "Description": "sample string 4",
      "PrivateObservations": "sample string 5",
      "Price": {
        "UnitAmount": 1.0,
        "Discount": 2.0,
        "DiscountPercent": 3.0,
        "UnitBase": 4.0,
        "TaxPercent": 5.0,
        "EquivalenceSurchargePercent": 6.0,
        "Base": 7.0,
        "Tax": 8.0,
        "EquivalenceSurcharge": 9.0,
        "Amount": 10.0
      }
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "Carrier": {
        "ID": 1,
        "Name": "sample string 2",
        "ProcessorTypeID": 1,
        "ProcessorEntityID": 1
      },
      "Amount": 3.0,
      "Description": "sample string 4",
      "PrivateObservations": "sample string 5",
      "Price": {
        "UnitAmount": 1.0,
        "Discount": 2.0,
        "DiscountPercent": 3.0,
        "UnitBase": 4.0,
        "TaxPercent": 5.0,
        "EquivalenceSurchargePercent": 6.0,
        "Base": 7.0,
        "Tax": 8.0,
        "EquivalenceSurcharge": 9.0,
        "Amount": 10.0
      }
    }
  ],
  "PickUpWarehouseID": 1,
  "TaxRateID": 8,
  "Price": {
    "UnitAmount": 1.0,
    "Discount": 2.0,
    "DiscountPercent": 3.0,
    "UnitBase": 4.0,
    "TaxPercent": 5.0,
    "EquivalenceSurchargePercent": 6.0,
    "Base": 7.0,
    "Tax": 8.0,
    "EquivalenceSurcharge": 9.0,
    "Amount": 10.0
  },
  "Observations": "sample string 9",
  "Appointments": [
    {
      "ID": 1,
      "Created": "2025-12-06T05:41:55.0940195+01:00",
      "Modified": "2025-12-06T05:41:55.0940195+01:00",
      "OrderShippingID": 4,
      "SlotID": 5,
      "SortOrder": 6,
      "Expiration": "2025-12-06T05:41:55.0940195+01:00"
    },
    {
      "ID": 1,
      "Created": "2025-12-06T05:41:55.0940195+01:00",
      "Modified": "2025-12-06T05:41:55.0940195+01:00",
      "OrderShippingID": 4,
      "SlotID": 5,
      "SortOrder": 6,
      "Expiration": "2025-12-06T05:41:55.0940195+01:00"
    }
  ]
}

application/xml, text/xml

Sample:

<OrderShipping xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Order">
  <ApplicableMeans>
    <OrderShippingMeans>
      <Amount>3</Amount>
      <Carrier xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Logistics">
        <d4p1:ID>1</d4p1:ID>
        <d4p1:Name>sample string 2</d4p1:Name>
        <d4p1:ProcessorEntityID>1</d4p1:ProcessorEntityID>
        <d4p1:ProcessorTypeID>1</d4p1:ProcessorTypeID>
      </Carrier>
      <Description>sample string 4</Description>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <Price xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </Price>
      <PrivateObservations>sample string 5</PrivateObservations>
    </OrderShippingMeans>
    <OrderShippingMeans>
      <Amount>3</Amount>
      <Carrier xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Logistics">
        <d4p1:ID>1</d4p1:ID>
        <d4p1:Name>sample string 2</d4p1:Name>
        <d4p1:ProcessorEntityID>1</d4p1:ProcessorEntityID>
        <d4p1:ProcessorTypeID>1</d4p1:ProcessorTypeID>
      </Carrier>
      <Description>sample string 4</Description>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <Price xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
        <d4p1:Amount>10</d4p1:Amount>
        <d4p1:Base>7</d4p1:Base>
        <d4p1:EquivalenceSurcharge>9</d4p1:EquivalenceSurcharge>
        <d4p1:EquivalenceSurchargePercent>6</d4p1:EquivalenceSurchargePercent>
        <d4p1:Tax>8</d4p1:Tax>
        <d4p1:TaxPercent>5</d4p1:TaxPercent>
        <d4p1:Discount>2</d4p1:Discount>
        <d4p1:DiscountPercent>3</d4p1:DiscountPercent>
        <d4p1:UnitAmount>1</d4p1:UnitAmount>
        <d4p1:UnitBase>4</d4p1:UnitBase>
      </Price>
      <PrivateObservations>sample string 5</PrivateObservations>
    </OrderShippingMeans>
  </ApplicableMeans>
  <Appointments xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Booking">
    <d2p1:ShippingAppointment>
      <d2p1:Created>2025-12-06T05:41:55.0940195+01:00</d2p1:Created>
      <d2p1:Expiration>2025-12-06T05:41:55.0940195+01:00</d2p1:Expiration>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Modified>2025-12-06T05:41:55.0940195+01:00</d2p1:Modified>
      <d2p1:OrderShippingID>4</d2p1:OrderShippingID>
      <d2p1:SlotID>5</d2p1:SlotID>
      <d2p1:SortOrder>6</d2p1:SortOrder>
    </d2p1:ShippingAppointment>
    <d2p1:ShippingAppointment>
      <d2p1:Created>2025-12-06T05:41:55.0940195+01:00</d2p1:Created>
      <d2p1:Expiration>2025-12-06T05:41:55.0940195+01:00</d2p1:Expiration>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Modified>2025-12-06T05:41:55.0940195+01:00</d2p1:Modified>
      <d2p1:OrderShippingID>4</d2p1:OrderShippingID>
      <d2p1:SlotID>5</d2p1:SlotID>
      <d2p1:SortOrder>6</d2p1:SortOrder>
    </d2p1:ShippingAppointment>
  </Appointments>
  <Contact xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
    <d2p1:Addressee>sample string 9</d2p1:Addressee>
    <d2p1:Country xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location">
      <d3p1:Code>sample string 3</d3p1:Code>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </d2p1:Country>
    <d2p1:Place xmlns:d3p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location">
      <d3p1:ID>1</d3p1:ID>
      <d3p1:LocalityID>4</d3p1:LocalityID>
      <d3p1:Name>sample string 2</d3p1:Name>
      <d3p1:PostalCode>sample string 3</d3p1:PostalCode>
    </d2p1:Place>
    <d2p1:PostalCode>sample string 11</d2p1:PostalCode>
    <d2p1:Street>sample string 10</d2p1:Street>
    <d2p1:Email>sample string 2</d2p1:Email>
    <d2p1:Phone>sample string 3</d2p1:Phone>
    <d2p1:WebURL>sample string 8</d2p1:WebURL>
    <d2p1:Alias>sample string 4</d2p1:Alias>
    <d2p1:Name>sample string 5</d2p1:Name>
    <d2p1:Surnames>sample string 6</d2p1:Surnames>
    <d2p1:VatIdentifier>sample string 7</d2p1:VatIdentifier>
    <d2p1:ID>1</d2p1:ID>
  </Contact>
  <Created>2025-12-06T05:41:55.0940195+01:00</Created>
  <DeliveryDate>2025-12-06T05:41:55.0940195+01:00</DeliveryDate>
  <DeliveryDays>6</DeliveryDays>
  <ID>1</ID>
  <Items>
    <OrderShippingItem>
      <ID>1</ID>
      <OrderItemID>4</OrderItemID>
      <Quantity>2</Quantity>
      <VariationID>3</VariationID>
    </OrderShippingItem>
    <OrderShippingItem>
      <ID>1</ID>
      <OrderItemID>4</OrderItemID>
      <Quantity>2</Quantity>
      <VariationID>3</VariationID>
    </OrderShippingItem>
  </Items>
  <Modified>2025-12-06T05:41:55.0940195+01:00</Modified>
  <Observations>sample string 9</Observations>
  <OrderID>2</OrderID>
  <PickUpWarehouseID>1</PickUpWarehouseID>
  <Price xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
    <d2p1:Amount>10</d2p1:Amount>
    <d2p1:Base>7</d2p1:Base>
    <d2p1:EquivalenceSurcharge>9</d2p1:EquivalenceSurcharge>
    <d2p1:EquivalenceSurchargePercent>6</d2p1:EquivalenceSurchargePercent>
    <d2p1:Tax>8</d2p1:Tax>
    <d2p1:TaxPercent>5</d2p1:TaxPercent>
    <d2p1:Discount>2</d2p1:Discount>
    <d2p1:DiscountPercent>3</d2p1:DiscountPercent>
    <d2p1:UnitAmount>1</d2p1:UnitAmount>
    <d2p1:UnitBase>4</d2p1:UnitBase>
  </Price>
  <ShippingMeans xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Logistics">
    <d2p1:BaseID>5</d2p1:BaseID>
    <d2p1:CarrierID>1</d2p1:CarrierID>
    <d2p1:CustomerPickUp>true</d2p1:CustomerPickUp>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:Disabled>2025-12-06T05:41:55.0940195+01:00</d2p1:Disabled>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:IsExpress>true</d2p1:IsExpress>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:PrivateObservations>sample string 4</d2p1:PrivateObservations>
    <d2p1:TaxRateID>7</d2p1:TaxRateID>
  </ShippingMeans>
  <ShippingMeansID>7</ShippingMeansID>
  <TaxRateID>8</TaxRateID>
</OrderShipping>