POST 3dCartWebAPI/v1/Orders/{orderid}/Items
Adds a new item on the order
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderid |
Order ID |
integer |
Required |
Body Parameters
A Json or XML object containing the new item
OrderItemName | Description | Type | Additional information |
---|---|---|---|
CatalogID |
database reference = oitems.catalogid |
integer |
None. |
ItemIndexID |
database reference = oitems.orderitemid |
integer |
None. |
ItemID |
database reference = oitems.itemid |
string |
String length: inclusive between 0 and 150 |
ItemShipmentID |
database reference = oitems.shipment_id |
integer |
None. |
ItemQuantity |
database reference = oitems.numitems |
decimal number |
None. |
ItemWarehouseID |
database reference = oitems.warehouseID |
integer |
None. |
ItemDescription |
database reference = oitems.itemname |
string |
String length: inclusive between 0 and 65535 |
ItemUnitPrice |
database reference = oitems.unitprice |
decimal number |
None. |
ItemWeight |
database reference = oitems.weight |
decimal number |
None. |
ItemOptionPrice |
database reference = oitems.optionprice |
decimal number |
None. |
ItemAdditionalField1 |
database reference = oitems.additional_field1 |
string |
String length: inclusive between 0 and 255 |
ItemAdditionalField2 |
database reference = oitems.additional_field2 |
string |
String length: inclusive between 0 and 255 |
ItemAdditionalField3 |
database reference = oitems.additional_field3 |
string |
String length: inclusive between 0 and 255 |
ItemPageAdded |
database reference = oitems.page_added |
string |
String length: inclusive between 0 and 255 |
ItemAvailability |
database reference = oitems.itemdescription |
string |
String length: inclusive between 0 and 150 |
ItemDateAdded |
database reference = oitems.date_added |
date |
None. |
ItemUnitCost |
database reference = oitems.unitcost |
decimal number |
None. |
ItemUnitStock |
database reference = oitems.unitstock |
decimal number |
None. |
ItemOptions |
database reference = oitems.options |
string |
String length: inclusive between 0 and 65535 |
ItemCatalogIDOptions |
database reference = oitems.catalogidoptions |
string |
String length: inclusive between 0 and 255 |
ItemSerial |
database reference = serials_used.catalogidoptions |
string |
String length: inclusive between 0 and 255 |
ItemImage1 |
database reference = products.image1 |
string |
String length: inclusive between 0 and 255 |
ItemImage2 |
database reference = products.image2 |
string |
String length: inclusive between 0 and 255 |
ItemImage3 |
database reference = products.image3 |
string |
String length: inclusive between 0 and 255 |
ItemImage4 |
database reference = products.image4 |
string |
String length: inclusive between 0 and 255 |
ItemWarehouseLocation |
database reference = products.warehouse_location |
string |
String length: inclusive between 0 and 150 |
ItemWarehouseBin |
database reference = products.warehouse_bin |
string |
String length: inclusive between 0 and 150 |
ItemWarehouseAisle |
database reference = products.warehouse_aisle |
string |
String length: inclusive between 0 and 150 |
ItemWarehouseCustom |
database reference = products.warehouse_custom |
string |
String length: inclusive between 0 and 150 |
RecurringOrderFrequency |
database reference = oitems.recurring_order_frequency |
integer |
None. |
Request Formats
application/json, text/json
{ "CatalogID": 1, "ItemIndexID": 1, "ItemID": "sample string 1", "ItemShipmentID": 1, "ItemQuantity": 1.1, "ItemWarehouseID": 1, "ItemDescription": "sample string 2", "ItemUnitPrice": 1.1, "ItemWeight": 1.1, "ItemOptionPrice": 1.1, "ItemAdditionalField1": "sample string 3", "ItemAdditionalField2": "sample string 4", "ItemAdditionalField3": "sample string 5", "ItemPageAdded": "sample string 6", "ItemAvailability": "sample string 7", "ItemDateAdded": "04/14/2024 17:39", "ItemUnitCost": 1.1, "ItemUnitStock": 1.1, "ItemOptions": "sample string 8", "ItemCatalogIDOptions": "sample string 9", "ItemSerial": "sample string 10", "ItemImage1": "sample string 11", "ItemImage2": "sample string 12", "ItemImage3": "sample string 13", "ItemImage4": "sample string 14", "ItemWarehouseLocation": "sample string 15", "ItemWarehouseBin": "sample string 16", "ItemWarehouseAisle": "sample string 17", "ItemWarehouseCustom": "sample string 18", "RecurringOrderFrequency": 1 }
application/xml, text/xml
<OrderItem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <CatalogID>1</CatalogID> <ItemIndexID>1</ItemIndexID> <ItemID>sample string 1</ItemID> <ItemShipmentID>1</ItemShipmentID> <ItemQuantity>1.1</ItemQuantity> <ItemWarehouseID>1</ItemWarehouseID> <ItemDescription>sample string 2</ItemDescription> <ItemUnitPrice>1.1</ItemUnitPrice> <ItemWeight>1.1</ItemWeight> <ItemOptionPrice>1.1</ItemOptionPrice> <ItemAdditionalField1>sample string 3</ItemAdditionalField1> <ItemAdditionalField2>sample string 4</ItemAdditionalField2> <ItemAdditionalField3>sample string 5</ItemAdditionalField3> <ItemPageAdded>sample string 6</ItemPageAdded> <ItemAvailability>sample string 7</ItemAvailability> <ItemDateAdded>2024-04-14T17:39:07.9788537-04:00</ItemDateAdded> <ItemUnitCost>1.1</ItemUnitCost> <ItemUnitStock>1.1</ItemUnitStock> <ItemOptions>sample string 8</ItemOptions> <ItemCatalogIDOptions>sample string 9</ItemCatalogIDOptions> <ItemSerial>sample string 10</ItemSerial> <ItemImage1>sample string 11</ItemImage1> <ItemImage2>sample string 12</ItemImage2> <ItemImage3>sample string 13</ItemImage3> <ItemImage4>sample string 14</ItemImage4> <ItemWarehouseLocation>sample string 15</ItemWarehouseLocation> <ItemWarehouseBin>sample string 16</ItemWarehouseBin> <ItemWarehouseAisle>sample string 17</ItemWarehouseAisle> <ItemWarehouseCustom>sample string 18</ItemWarehouseCustom> <RecurringOrderFrequency>1</RecurringOrderFrequency> </OrderItem>
Sample Request |
|
Response Information
application/json, text/json
[ { "Key":"ItemIndexID", "Value":"1234", "Status":"201", "Message":"Created successfully", } ]
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |