POST v1/Orders/{orderId}/Shipments

Adds the specified shipment.

Request Information

Requires Authorization!

URI Parameters

Name	Description	Type	Additional information
orderId	The order identifier.	integer	Required.

Body Parameters

The order shipment.

ShipmentChanges

Name	Description	Type	Additional information
SynchronizeParameters	Gets or sets a value indicating whether the parameters are synchronized.	boolean	None.
SynchronizeShippingLabels	Gets or sets a value indicating whether the packages are synchronized.	boolean	None.
LastCarrierUpdate	The timestamp of the last status check with the Carrier.	date	None.
CarrierName	The name of the Carrier used.	string	None.
ShipperTrackingUrl	Gets or sets the shipper tracking URL.	string	None.
DeliveredDate	The timestamp the complete Shipment was delivered. This timestamp is based on the DeliveryDate of all containing labels/packages.	date	None.
Params	Gets or sets the shipment parameters.	Collection of CarrierParameter	None.
ShippingLabels	Gets or sets the shipment packages.	Collection of ShippingLabel	None.
Id	Gets or sets the identifier.	integer	Must be 0
TrackingCode	Gets or sets the tracking code.	string	Max length: 2147483647
CreateTimestamp	Gets or sets the create timestamp.	date	Required
ShopId	Gets or sets the Shop identifier.	integer	Required
OrderId	Gets or sets the Order identifier.	integer	None.
CarrierAccountId	Gets or sets the Carrier account.	integer	Required
ShipmentStatusId	The status Id of the Shipment. Possible values: NotPlanned = 1, Planned = 2, Shipping = 3, Delivered = 4, Cancelled = 5, Exception = 6, Deleted = 7, Partiallydelivered = 8,	integer	None.
ShipmentStatus	The status of the Shipment.	string	None.
IsReturn	Indicates whether the Shipment is a return shipment.	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "SynchronizeParameters": true,
  "SynchronizeShippingLabels": true,
  "LastCarrierUpdate": "2026-04-03T18:26:38.2686632+02:00",
  "CarrierName": "sample string 3",
  "ShipperTrackingUrl": "sample string 4",
  "DeliveredDate": "2026-04-03T18:26:38.2686632+02:00",
  "Params": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "ShippingLabels": [
    {
      "Id": 1,
      "TrackingCode": "sample string 2",
      "DeliveryStatusId": 3,
      "Weight": 4,
      "Length": 5,
      "Width": 6,
      "Height": 7,
      "DeliveredDate": "2026-04-03T18:26:38.2686632+02:00",
      "LastCarrierUpdate": "2026-04-03T18:26:38.2686632+02:00",
      "LastCarrierStatus": "sample string 8"
    },
    {
      "Id": 1,
      "TrackingCode": "sample string 2",
      "DeliveryStatusId": 3,
      "Weight": 4,
      "Length": 5,
      "Width": 6,
      "Height": 7,
      "DeliveredDate": "2026-04-03T18:26:38.2686632+02:00",
      "LastCarrierUpdate": "2026-04-03T18:26:38.2686632+02:00",
      "LastCarrierStatus": "sample string 8"
    }
  ],
  "Id": 5,
  "TrackingCode": "sample string 6",
  "CreateTimestamp": "2026-04-03T18:26:38.2686632+02:00",
  "ShopId": 8,
  "OrderId": 1,
  "CarrierAccountId": 9,
  "ShipmentStatusId": 10,
  "ShipmentStatus": "10",
  "IsReturn": true
}

application/xml, text/xml

Sample:

<ShipmentChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>5</Id>
  <TrackingCode>sample string 6</TrackingCode>
  <CreateTimestamp>2026-04-03T18:26:38.2686632+02:00</CreateTimestamp>
  <ShopId>8</ShopId>
  <OrderId>1</OrderId>
  <CarrierAccountId>9</CarrierAccountId>
  <ShipmentStatusId>10</ShipmentStatusId>
  <IsReturn>true</IsReturn>
  <LastCarrierUpdate>2026-04-03T18:26:38.2686632+02:00</LastCarrierUpdate>
  <CarrierName>sample string 3</CarrierName>
  <ShipperTrackingUrl>sample string 4</ShipperTrackingUrl>
  <DeliveredDate>2026-04-03T18:26:38.2686632+02:00</DeliveredDate>
  <Params>
    <Parameters>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Parameters>
    <Parameters>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Parameters>
  </Params>
  <ShippingLabels>
    <ShippingLabels>
      <Id>1</Id>
      <TrackingCode>sample string 2</TrackingCode>
      <DeliveryStatusId>3</DeliveryStatusId>
      <Weight>4</Weight>
      <Length>5</Length>
      <Width>6</Width>
      <Height>7</Height>
      <DeliveredDate>2026-04-03T18:26:38.2686632+02:00</DeliveredDate>
      <LastCarrierUpdate>2026-04-03T18:26:38.2686632+02:00</LastCarrierUpdate>
      <LastCarrierStatus>sample string 8</LastCarrierStatus>
    </ShippingLabels>
    <ShippingLabels>
      <Id>1</Id>
      <TrackingCode>sample string 2</TrackingCode>
      <DeliveryStatusId>3</DeliveryStatusId>
      <Weight>4</Weight>
      <Length>5</Length>
      <Width>6</Width>
      <Height>7</Height>
      <DeliveredDate>2026-04-03T18:26:38.2686632+02:00</DeliveredDate>
      <LastCarrierUpdate>2026-04-03T18:26:38.2686632+02:00</LastCarrierUpdate>
      <LastCarrierStatus>sample string 8</LastCarrierStatus>
    </ShippingLabels>
  </ShippingLabels>
  <SynchronizeParameters>true</SynchronizeParameters>
  <SynchronizeShippingLabels>true</SynchronizeShippingLabels>
</ShipmentChanges>

Response Information

Resource Description

The HttpResponseMessage object.

Shipment

Name	Description	Type	Additional information
LastCarrierUpdate	The timestamp of the last status check with the Carrier.	date	None.
CarrierName	The name of the Carrier used.	string	None.
ShipperTrackingUrl	Gets or sets the shipper tracking URL.	string	None.
DeliveredDate	The timestamp the complete Shipment was delivered. This timestamp is based on the DeliveryDate of all containing labels/packages.	date	None.
Params	Gets or sets the shipment parameters.	Collection of CarrierParameter	None.
ShippingLabels	Gets or sets the shipment packages.	Collection of ShippingLabel	None.
Id	Gets or sets the identifier.	integer	Must be 0
TrackingCode	Gets or sets the tracking code.	string	Max length: 2147483647
CreateTimestamp	Gets or sets the create timestamp.	date	Required
ShopId	Gets or sets the Shop identifier.	integer	Required
OrderId	Gets or sets the Order identifier.	integer	None.
CarrierAccountId	Gets or sets the Carrier account.	integer	Required
ShipmentStatusId	The status Id of the Shipment. Possible values: NotPlanned = 1, Planned = 2, Shipping = 3, Delivered = 4, Cancelled = 5, Exception = 6, Deleted = 7, Partiallydelivered = 8,	integer	None.
ShipmentStatus	The status of the Shipment.	string	None.
IsReturn	Indicates whether the Shipment is a return shipment.	boolean	Required

Response Formats

application/json, text/json

Sample:

{
  "LastCarrierUpdate": "2026-04-03T18:26:38.2807222+02:00",
  "CarrierName": "sample string 1",
  "ShipperTrackingUrl": "sample string 2",
  "DeliveredDate": "2026-04-03T18:26:38.2807222+02:00",
  "Params": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "ShippingLabels": [
    {
      "Id": 1,
      "TrackingCode": "sample string 2",
      "DeliveryStatusId": 3,
      "Weight": 4,
      "Length": 5,
      "Width": 6,
      "Height": 7,
      "DeliveredDate": "2026-04-03T18:26:38.2807222+02:00",
      "LastCarrierUpdate": "2026-04-03T18:26:38.2807222+02:00",
      "LastCarrierStatus": "sample string 8"
    },
    {
      "Id": 1,
      "TrackingCode": "sample string 2",
      "DeliveryStatusId": 3,
      "Weight": 4,
      "Length": 5,
      "Width": 6,
      "Height": 7,
      "DeliveredDate": "2026-04-03T18:26:38.2807222+02:00",
      "LastCarrierUpdate": "2026-04-03T18:26:38.2807222+02:00",
      "LastCarrierStatus": "sample string 8"
    }
  ],
  "Id": 3,
  "TrackingCode": "sample string 4",
  "CreateTimestamp": "2026-04-03T18:26:38.2807222+02:00",
  "ShopId": 6,
  "OrderId": 1,
  "CarrierAccountId": 7,
  "ShipmentStatusId": 8,
  "ShipmentStatus": "Partiallydelivered",
  "IsReturn": true
}

application/xml, text/xml

Sample:

<Shipment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>3</Id>
  <TrackingCode>sample string 4</TrackingCode>
  <CreateTimestamp>2026-04-03T18:26:38.2807222+02:00</CreateTimestamp>
  <ShopId>6</ShopId>
  <OrderId>1</OrderId>
  <CarrierAccountId>7</CarrierAccountId>
  <ShipmentStatusId>8</ShipmentStatusId>
  <IsReturn>true</IsReturn>
  <LastCarrierUpdate>2026-04-03T18:26:38.2807222+02:00</LastCarrierUpdate>
  <CarrierName>sample string 1</CarrierName>
  <ShipperTrackingUrl>sample string 2</ShipperTrackingUrl>
  <DeliveredDate>2026-04-03T18:26:38.2807222+02:00</DeliveredDate>
  <Params>
    <Parameters>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Parameters>
    <Parameters>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Parameters>
  </Params>
  <ShippingLabels>
    <ShippingLabels>
      <Id>1</Id>
      <TrackingCode>sample string 2</TrackingCode>
      <DeliveryStatusId>3</DeliveryStatusId>
      <Weight>4</Weight>
      <Length>5</Length>
      <Width>6</Width>
      <Height>7</Height>
      <DeliveredDate>2026-04-03T18:26:38.2807222+02:00</DeliveredDate>
      <LastCarrierUpdate>2026-04-03T18:26:38.2807222+02:00</LastCarrierUpdate>
      <LastCarrierStatus>sample string 8</LastCarrierStatus>
    </ShippingLabels>
    <ShippingLabels>
      <Id>1</Id>
      <TrackingCode>sample string 2</TrackingCode>
      <DeliveryStatusId>3</DeliveryStatusId>
      <Weight>4</Weight>
      <Length>5</Length>
      <Width>6</Width>
      <Height>7</Height>
      <DeliveredDate>2026-04-03T18:26:38.2807222+02:00</DeliveredDate>
      <LastCarrierUpdate>2026-04-03T18:26:38.2807222+02:00</LastCarrierUpdate>
      <LastCarrierStatus>sample string 8</LastCarrierStatus>
    </ShippingLabels>
  </ShippingLabels>
</Shipment>