POST /apiv2/items/createComplex
Servers
- /
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
companyId |
Integer | No |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
id |
Integer | No |
The Machship Id for this item |
name |
String | Yes |
Name or description of the goods you are sending |
sku |
String | No |
Optional: the SKU or code of the item you are sending |
combinedLoadSize |
Object | No | |
combinedLoadSize.height |
Number | No | |
combinedLoadSize.length |
Number | No | |
combinedLoadSize.width |
Number | No | |
combinedLoadSize.weight |
Number | No | |
combinedItem |
Object | No | |
combinedItem.totalWeight |
Number | No |
Total weight in kg of the combined item |
combinedItem.heaviestIndividualItem |
Number | No |
Weight in kg of the heaviest individual item that comprises the combined item |
combinedItem.totalWidth |
Number | No |
Total width in cm of the combined item |
combinedItem.totalHeight |
Number | No |
Total height in cm of the combined item |
combinedItem.totalLength |
Number | No |
Total length in cm of the combined item |
combinedItem.numberOfPieces |
Integer | No |
Number of individual pieces that comprise the combined item |
quantity |
Integer | Yes |
Number of items |
itemType |
Integer | Yes |
1 = Carton, 2 = Skid, 3 = Pallet, 4 = Crate, 5 = Satchel, 6 = Roll, 7 = Panel, 8 = Bag, 9 = Tube, 10 = Stillage, 11 = Envelope, 12 = Pack, 13 = Rails, 14 = TimberLoose, 15 = Combined, 16 = TimberPack, 17 = Pipe, 18 = BDouble, 19 = Semi, 20 = TwentyFootContainer, 21 = FortyFootContainer, 22 = Bundle, 23 = Case, 24 = Volume, 26 = IBC, 27 = GLPallet, 28 = GLTrolley, 29 = GLCarton, 30 = Trolley, 31 = TotalVolume, 32 = Drum, 33 = Loscam, 34 = LoscamWood, 35 = LoscamPlastic, 36 = Chep, 37 = ChepWood, 38 = ChepPlastic, 39 = Tray, 40 = Pot, 41 = SeedlingRack, 42 = SilverTrolley, 43 = LightTruckTyre, 44 = PassengerTyre, 45 = AgriculturalTyre, 46 = MowerTyre, 47 = SolidTyre, 48 = TractorTyre, 49 = TrailerTyre, 50 = TruckTyre, 51 = Pallecon, 52 = Item, 53 = Machine, 54 = JiffyBag, 55 = Pot200mm, 56 = Pot250mm, 57 = Pot300mm, 58 = Flatpack, 59 = BrandedPallet, 60 = Disposable, 61 = Plastic Possible values:
|
standardItem |
Object | No | |
standardItem.height |
Number | No |
Height of the item in cm |
standardItem.length |
Number | No |
Length of the item in cm |
standardItem.width |
Number | No |
Width of the item in cm |
standardItem.weight |
Number | No |
Weight of the item in kg |
veryFrequentItem |
Boolean | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.