GET 3dCartWebAPI/v1/Orders/{orderid}/Shipments
Gets the shipments from a specific Order
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderid | integer |
Default value is 0 |
|
limit |
Maximum number of items that can be returned |
integer |
Default value is 0 |
offset |
Starting point for the return data |
integer |
Default value is 0 |
Body Parameters
None.
Sample Request |
|
Response Information
Resource Description
Collection of ShipmentName | Description | Type | Additional information |
---|---|---|---|
ShipmentID |
database reference = orders_shipments.id |
integer |
None. |
ShipmentLastUpdate |
database reference = orders_shipments.last_update |
date |
None. |
ShipmentBoxes |
database reference = orders_shipments.oboxes |
integer |
None. |
ShipmentInternalComment |
database reference = orders_shipments.ointernalcomment |
string |
String length: inclusive between 0 and 65535 |
ShipmentOrderStatus |
database reference = orders_shipments.order_status |
integer |
None. |
ShipmentAddress |
database reference = orders_shipments.oshipaddress |
string |
String length: inclusive between 0 and 255 |
ShipmentAddress2 |
database reference = orders_shipments.oshipaddress2 |
string |
String length: inclusive between 0 and 50 |
ShipmentAlias |
database reference = orders_shipments.oshipalias |
string |
String length: inclusive between 0 and 100 |
ShipmentCity |
database reference = orders_shipments.oshipcity |
string |
String length: inclusive between 0 and 50 |
ShipmentCompany |
database reference = orders_shipments.oshipcompany |
string |
String length: inclusive between 0 and 200 |
ShipmentCost |
database reference = orders_shipments.oshipcost |
decimal number |
None. |
ShipmentCountry |
database reference = orders_shipments.oshipcountry |
string |
String length: inclusive between 0 and 50 |
ShipmentEmail |
database reference = orders_shipments.oshipemail |
string |
String length: inclusive between 0 and 100 |
ShipmentFirstName |
database reference = orders_shipments.oshipfirstname |
string |
String length: inclusive between 0 and 100 |
ShipmentLastName |
database reference = orders_shipments.oshiplastname |
string |
String length: inclusive between 0 and 50 |
ShipmentMethodID |
database reference = orders_shipments.shipping_id |
integer |
None. |
ShipmentMethodName |
database reference = orders_shipments.oshipmethod |
string |
String length: inclusive between 0 and 150 |
ShipmentShippedDate |
database reference = orders_shipments.oshippeddate |
string |
String length: inclusive between 0 and 50 |
ShipmentPhone |
database reference = orders_shipments.oshipphone |
string |
String length: inclusive between 0 and 50 |
ShipmentState |
database reference = orders_shipments.oshipstate |
string |
String length: inclusive between 0 and 50 |
ShipmentZipCode |
database reference = orders_shipments.oshipzip |
string |
String length: inclusive between 0 and 20 |
ShipmentTax |
database reference = orders_shipments.otax |
decimal number |
None. |
ShipmentWeight |
database reference = orders_shipments.oweight |
decimal number |
None. |
ShipmentTrackingCode |
database reference = orders_shipments.trackingcode |
string |
String length: inclusive between 0 and 100 |
ShipmentUserID |
database reference = orders_shipments.userid |
string |
String length: inclusive between 0 and 50 |
ShipmentNumber |
database reference = orders_shipments.shipment_number |
integer |
None. |
ShipmentAddressTypeID |
database reference = orders_shipments.oshipaddresstype |
integer |
None. |
Response Formats
application/json, text/json
[ { "ShipmentID": 1, "ShipmentLastUpdate": "04/16/2024 14:06", "ShipmentBoxes": 1, "ShipmentInternalComment": "sample string 1", "ShipmentOrderStatus": 1, "ShipmentAddress": "sample string 2", "ShipmentAddress2": "sample string 3", "ShipmentAlias": "sample string 4", "ShipmentCity": "sample string 5", "ShipmentCompany": "sample string 6", "ShipmentCost": 1.1, "ShipmentCountry": "sample string 7", "ShipmentEmail": "sample string 8", "ShipmentFirstName": "sample string 9", "ShipmentLastName": "sample string 10", "ShipmentMethodID": 1, "ShipmentMethodName": "sample string 11", "ShipmentShippedDate": "sample string 12", "ShipmentPhone": "sample string 13", "ShipmentState": "sample string 14", "ShipmentZipCode": "sample string 15", "ShipmentTax": 1.1, "ShipmentWeight": 1.1, "ShipmentTrackingCode": "sample string 16", "ShipmentUserID": "sample string 17", "ShipmentNumber": 1, "ShipmentAddressTypeID": 1 }, { "ShipmentID": 1, "ShipmentLastUpdate": "04/16/2024 14:06", "ShipmentBoxes": 1, "ShipmentInternalComment": "sample string 1", "ShipmentOrderStatus": 1, "ShipmentAddress": "sample string 2", "ShipmentAddress2": "sample string 3", "ShipmentAlias": "sample string 4", "ShipmentCity": "sample string 5", "ShipmentCompany": "sample string 6", "ShipmentCost": 1.1, "ShipmentCountry": "sample string 7", "ShipmentEmail": "sample string 8", "ShipmentFirstName": "sample string 9", "ShipmentLastName": "sample string 10", "ShipmentMethodID": 1, "ShipmentMethodName": "sample string 11", "ShipmentShippedDate": "sample string 12", "ShipmentPhone": "sample string 13", "ShipmentState": "sample string 14", "ShipmentZipCode": "sample string 15", "ShipmentTax": 1.1, "ShipmentWeight": 1.1, "ShipmentTrackingCode": "sample string 16", "ShipmentUserID": "sample string 17", "ShipmentNumber": 1, "ShipmentAddressTypeID": 1 } ]
application/xml, text/xml
<ArrayOfShipment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Shipment> <ShipmentID>1</ShipmentID> <ShipmentLastUpdate>2024-04-16T14:06:45.248354-04:00</ShipmentLastUpdate> <ShipmentBoxes>1</ShipmentBoxes> <ShipmentInternalComment>sample string 1</ShipmentInternalComment> <ShipmentOrderStatus>1</ShipmentOrderStatus> <ShipmentAddress>sample string 2</ShipmentAddress> <ShipmentAddress2>sample string 3</ShipmentAddress2> <ShipmentAlias>sample string 4</ShipmentAlias> <ShipmentCity>sample string 5</ShipmentCity> <ShipmentCompany>sample string 6</ShipmentCompany> <ShipmentCost>1.1</ShipmentCost> <ShipmentCountry>sample string 7</ShipmentCountry> <ShipmentEmail>sample string 8</ShipmentEmail> <ShipmentFirstName>sample string 9</ShipmentFirstName> <ShipmentLastName>sample string 10</ShipmentLastName> <ShipmentMethodID>1</ShipmentMethodID> <ShipmentMethodName>sample string 11</ShipmentMethodName> <ShipmentShippedDate>sample string 12</ShipmentShippedDate> <ShipmentPhone>sample string 13</ShipmentPhone> <ShipmentState>sample string 14</ShipmentState> <ShipmentZipCode>sample string 15</ShipmentZipCode> <ShipmentTax>1.1</ShipmentTax> <ShipmentWeight>1.1</ShipmentWeight> <ShipmentTrackingCode>sample string 16</ShipmentTrackingCode> <ShipmentUserID>sample string 17</ShipmentUserID> <ShipmentNumber>1</ShipmentNumber> <ShipmentAddressTypeID>1</ShipmentAddressTypeID> </Shipment> <Shipment> <ShipmentID>1</ShipmentID> <ShipmentLastUpdate>2024-04-16T14:06:45.248354-04:00</ShipmentLastUpdate> <ShipmentBoxes>1</ShipmentBoxes> <ShipmentInternalComment>sample string 1</ShipmentInternalComment> <ShipmentOrderStatus>1</ShipmentOrderStatus> <ShipmentAddress>sample string 2</ShipmentAddress> <ShipmentAddress2>sample string 3</ShipmentAddress2> <ShipmentAlias>sample string 4</ShipmentAlias> <ShipmentCity>sample string 5</ShipmentCity> <ShipmentCompany>sample string 6</ShipmentCompany> <ShipmentCost>1.1</ShipmentCost> <ShipmentCountry>sample string 7</ShipmentCountry> <ShipmentEmail>sample string 8</ShipmentEmail> <ShipmentFirstName>sample string 9</ShipmentFirstName> <ShipmentLastName>sample string 10</ShipmentLastName> <ShipmentMethodID>1</ShipmentMethodID> <ShipmentMethodName>sample string 11</ShipmentMethodName> <ShipmentShippedDate>sample string 12</ShipmentShippedDate> <ShipmentPhone>sample string 13</ShipmentPhone> <ShipmentState>sample string 14</ShipmentState> <ShipmentZipCode>sample string 15</ShipmentZipCode> <ShipmentTax>1.1</ShipmentTax> <ShipmentWeight>1.1</ShipmentWeight> <ShipmentTrackingCode>sample string 16</ShipmentTrackingCode> <ShipmentUserID>sample string 17</ShipmentUserID> <ShipmentNumber>1</ShipmentNumber> <ShipmentAddressTypeID>1</ShipmentAddressTypeID> </Shipment> </ArrayOfShipment>