Pricing Templates
Log in Sign up
Integrations / Machship / ...

POST /apiv2/carrierInvoices/updateAndRepriceConsignment

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
items[] Array No
items[].quantity Integer No

Number of items
items[].itemType Integer No

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:

  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 10
  • 54
  • 11
  • 55
  • 12
  • 56
  • 13
  • 57
  • 14
  • 58
  • 15
  • 59
  • 16
  • 17
  • 18
  • 19
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 60
  • 61
  • 20
  • 21
  • 22
  • 23
  • 24
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
items[].standardItem Object No
items[].standardItem.height Number No

Height of the item in cm
items[].standardItem.length Number No

Length of the item in cm
items[].standardItem.width Number No

Width of the item in cm
items[].standardItem.weight Number No

Weight of the item in kg
items[].consignmentItemContents[] Array No
items[].consignmentItemContents[].description String Yes
items[].consignmentItemContents[].countryOfManufactureId Integer No
items[].consignmentItemContents[].quantity Integer No
items[].consignmentItemContents[].ciMarksAndNumbers String No
items[].consignmentItemContents[].purpose String No
items[].consignmentItemContents[].harmonizedCode String No
items[].consignmentItemContents[].reference2 String No
items[].consignmentItemContents[].dollarValue Number No
items[].consignmentItemContents[].reference3 String No
items[].consignmentItemContents[].reference1 String No
items[].consignmentItemContents[].partNumber String No
items[].consignmentItemContents[].countryOfManufactureCode String No
items[].consignmentItemContents[].countryOfManufacture Object No
items[].consignmentItemContents[].countryOfManufacture.id Integer No
items[].consignmentItemContents[].countryOfManufacture.currencyCode String No
items[].consignmentItemContents[].countryOfManufacture.name String No
items[].consignmentItemContents[].countryOfManufacture.numeric String No
items[].consignmentItemContents[].countryOfManufacture.taxPercentage Number No
items[].consignmentItemContents[].countryOfManufacture.displayName String No
items[].consignmentItemContents[].countryOfManufacture.code3 String No
items[].consignmentItemContents[].countryOfManufacture.code2 String No
items[].id Integer No

This is populated IF it is an existing unmanifested consignment's consignment item ID
items[].name String No

Name or description of the goods you are sending
items[].sku String No

Optional: the SKU or code of the item you are sending
items[].combinedLoadSize Object No
items[].combinedLoadSize.height Number No
items[].combinedLoadSize.length Number No
items[].combinedLoadSize.width Number No
items[].combinedLoadSize.weight Number No
items[].consignmentItemReferences[] Array No
items[].consignmentItemReferences[].printedDateUtc String No
items[].consignmentItemReferences[].printed Boolean No
items[].combinedItem Object No
items[].combinedItem.totalWeight Number No

Total weight in kg of the combined item
items[].combinedItem.heaviestIndividualItem Number No

Weight in kg of the heaviest individual item that comprises the combined item
items[].combinedItem.totalWidth Number No

Total width in cm of the combined item
items[].combinedItem.totalHeight Number No

Total height in cm of the combined item
items[].combinedItem.totalLength Number No

Total length in cm of the combined item
items[].combinedItem.numberOfPieces Integer No

Number of individual pieces that comprise the combined item
items[].consignmentItemDgItems[] Array No
items[].consignmentItemDgItems[].packingGroup Integer No

1 = One, 2 = Two, 3 = Three, 4 = None

Possible values:

  • 1
  • 2
  • 3
  • 4
items[].consignmentItemDgItems[].unNumber Integer No
items[].consignmentItemDgItems[].dgClassType Integer No

2 = FlammableGas, 3 = OtherGas, 4 = ToxicGas, 5 = FlammableLiquid, 6 = FlammableSolid, 7 = SpontaneouslyCombustible, 8 = DangerousWhenWet, 9 = OxidizingAgent, 10 = OrganicPeroxide, 11 = ToxicSubstance, 12 = InfectiousSubstance, 13 = Radioactive, 14 = Corrosive, 15 = Miscellaneous, 16 = Explosive1A, 17 = Explosive1B, 18 = Explosive1C, 19 = Explosive1D, 20 = Explosive1E, 21 = Explosive1F, 22 = Explosive1G, 23 = Explosive1J, 24 = Explosive1L, 25 = Explosive2B, 26 = Explosive2C, 27 = Explosive2D, 28 = Explosive2E, 29 = Explosive2F, 30 = Explosive2G, 31 = Explosive2H, 32 = Explosive2J, 33 = Explosive2K, 34 = Explosive2L, 35 = Explosive3C, 36 = Explosive3G, 37 = Explosive3H, 38 = Explosive3J, 39 = Explosive3K, 40 = Explosive3L, 41 = Explosive4B, 42 = Explosive4C, 43 = Explosive4D, 44 = Explosive4E, 45 = Explosive4F, 46 = Explosive4G, 47 = Explosive4S, 48 = Explosive5D, 49 = Explosive6N

Possible values:

  • 22
  • 44
  • 23
  • 45
  • 24
  • 46
  • 25
  • 47
  • 26
  • 48
  • 27
  • 49
  • 28
  • 29
  • 30
  • 31
  • 10
  • 32
  • 11
  • 33
  • 12
  • 34
  • 13
  • 35
  • 14
  • 36
  • 15
  • 37
  • 16
  • 38
  • 17
  • 39
  • 18
  • 19
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 40
  • 41
  • 20
  • 42
  • 21
  • 43
items[].consignmentItemDgItems[].unNumberInfo Object No
items[].consignmentItemDgItems[].unNumberInfo.packingGroup Integer No

1 = One, 2 = Two, 3 = Three, 4 = None

Possible values:

  • 1
  • 2
  • 3
  • 4
items[].consignmentItemDgItems[].unNumberInfo.unNumber Integer No
items[].consignmentItemDgItems[].unNumberInfo.name String No
items[].consignmentItemDgItems[].unNumberInfo.packingGroupName String No
items[].consignmentItemDgItems[].unNumberInfo.subClassesForDisplay String No
items[].consignmentItemDgItems[].unNumberInfo.classesForDisplay String No
items[].consignmentItemDgItems[].unNumberInfo.class Object No
items[].consignmentItemDgItems[].unNumberInfo.class.label String No
items[].consignmentItemDgItems[].unNumberInfo.class.class String No
items[].consignmentItemDgItems[].unNumberInfo.class.classType Integer No

2 = FlammableGas, 3 = OtherGas, 4 = ToxicGas, 5 = FlammableLiquid, 6 = FlammableSolid, 7 = SpontaneouslyCombustible, 8 = DangerousWhenWet, 9 = OxidizingAgent, 10 = OrganicPeroxide, 11 = ToxicSubstance, 12 = InfectiousSubstance, 13 = Radioactive, 14 = Corrosive, 15 = Miscellaneous, 16 = Explosive1A, 17 = Explosive1B, 18 = Explosive1C, 19 = Explosive1D, 20 = Explosive1E, 21 = Explosive1F, 22 = Explosive1G, 23 = Explosive1J, 24 = Explosive1L, 25 = Explosive2B, 26 = Explosive2C, 27 = Explosive2D, 28 = Explosive2E, 29 = Explosive2F, 30 = Explosive2G, 31 = Explosive2H, 32 = Explosive2J, 33 = Explosive2K, 34 = Explosive2L, 35 = Explosive3C, 36 = Explosive3G, 37 = Explosive3H, 38 = Explosive3J, 39 = Explosive3K, 40 = Explosive3L, 41 = Explosive4B, 42 = Explosive4C, 43 = Explosive4D, 44 = Explosive4E, 45 = Explosive4F, 46 = Explosive4G, 47 = Explosive4S, 48 = Explosive5D, 49 = Explosive6N

Possible values:

  • 22
  • 44
  • 23
  • 45
  • 24
  • 46
  • 25
  • 47
  • 26
  • 48
  • 27
  • 49
  • 28
  • 29
  • 30
  • 31
  • 10
  • 32
  • 11
  • 33
  • 12
  • 34
  • 13
  • 35
  • 14
  • 36
  • 15
  • 37
  • 16
  • 38
  • 17
  • 39
  • 18
  • 19
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 40
  • 41
  • 20
  • 42
  • 21
  • 43
items[].consignmentItemDgItems[].unNumberInfo.class.subRisk Boolean No
items[].consignmentItemDgItems[].unNumberInfo.class.division String No
items[].consignmentItemDgItems[].unNumberInfo.classes[] Array No
items[].consignmentItemDgItems[].unNumberInfo.classes[].label String No
items[].consignmentItemDgItems[].unNumberInfo.classes[].class String No
items[].consignmentItemDgItems[].unNumberInfo.classes[].classType Integer No

2 = FlammableGas, 3 = OtherGas, 4 = ToxicGas, 5 = FlammableLiquid, 6 = FlammableSolid, 7 = SpontaneouslyCombustible, 8 = DangerousWhenWet, 9 = OxidizingAgent, 10 = OrganicPeroxide, 11 = ToxicSubstance, 12 = InfectiousSubstance, 13 = Radioactive, 14 = Corrosive, 15 = Miscellaneous, 16 = Explosive1A, 17 = Explosive1B, 18 = Explosive1C, 19 = Explosive1D, 20 = Explosive1E, 21 = Explosive1F, 22 = Explosive1G, 23 = Explosive1J, 24 = Explosive1L, 25 = Explosive2B, 26 = Explosive2C, 27 = Explosive2D, 28 = Explosive2E, 29 = Explosive2F, 30 = Explosive2G, 31 = Explosive2H, 32 = Explosive2J, 33 = Explosive2K, 34 = Explosive2L, 35 = Explosive3C, 36 = Explosive3G, 37 = Explosive3H, 38 = Explosive3J, 39 = Explosive3K, 40 = Explosive3L, 41 = Explosive4B, 42 = Explosive4C, 43 = Explosive4D, 44 = Explosive4E, 45 = Explosive4F, 46 = Explosive4G, 47 = Explosive4S, 48 = Explosive5D, 49 = Explosive6N

Possible values:

  • 22
  • 44
  • 23
  • 45
  • 24
  • 46
  • 25
  • 47
  • 26
  • 48
  • 27
  • 49
  • 28
  • 29
  • 30
  • 31
  • 10
  • 32
  • 11
  • 33
  • 12
  • 34
  • 13
  • 35
  • 14
  • 36
  • 15
  • 37
  • 16
  • 38
  • 17
  • 39
  • 18
  • 19
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 40
  • 41
  • 20
  • 42
  • 21
  • 43
items[].consignmentItemDgItems[].unNumberInfo.classes[].subRisk Boolean No
items[].consignmentItemDgItems[].unNumberInfo.classes[].division String No
items[].consignmentItemDgItems[].unNumberInfo.subClasses[] Array No
items[].consignmentItemDgItems[].unNumberInfo.subClasses[].label String No
items[].consignmentItemDgItems[].unNumberInfo.subClasses[].class String No
items[].consignmentItemDgItems[].unNumberInfo.subClasses[].classType Integer No

2 = FlammableGas, 3 = OtherGas, 4 = ToxicGas, 5 = FlammableLiquid, 6 = FlammableSolid, 7 = SpontaneouslyCombustible, 8 = DangerousWhenWet, 9 = OxidizingAgent, 10 = OrganicPeroxide, 11 = ToxicSubstance, 12 = InfectiousSubstance, 13 = Radioactive, 14 = Corrosive, 15 = Miscellaneous, 16 = Explosive1A, 17 = Explosive1B, 18 = Explosive1C, 19 = Explosive1D, 20 = Explosive1E, 21 = Explosive1F, 22 = Explosive1G, 23 = Explosive1J, 24 = Explosive1L, 25 = Explosive2B, 26 = Explosive2C, 27 = Explosive2D, 28 = Explosive2E, 29 = Explosive2F, 30 = Explosive2G, 31 = Explosive2H, 32 = Explosive2J, 33 = Explosive2K, 34 = Explosive2L, 35 = Explosive3C, 36 = Explosive3G, 37 = Explosive3H, 38 = Explosive3J, 39 = Explosive3K, 40 = Explosive3L, 41 = Explosive4B, 42 = Explosive4C, 43 = Explosive4D, 44 = Explosive4E, 45 = Explosive4F, 46 = Explosive4G, 47 = Explosive4S, 48 = Explosive5D, 49 = Explosive6N

Possible values:

  • 22
  • 44
  • 23
  • 45
  • 24
  • 46
  • 25
  • 47
  • 26
  • 48
  • 27
  • 49
  • 28
  • 29
  • 30
  • 31
  • 10
  • 32
  • 11
  • 33
  • 12
  • 34
  • 13
  • 35
  • 14
  • 36
  • 15
  • 37
  • 16
  • 38
  • 17
  • 39
  • 18
  • 19
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 40
  • 41
  • 20
  • 42
  • 21
  • 43
items[].consignmentItemDgItems[].unNumberInfo.subClasses[].subRisk Boolean No
items[].consignmentItemDgItems[].unNumberInfo.subClasses[].division String No
items[].consignmentItemDgItems[].unNumberInfo.requiresTechnicalName Boolean No
items[].consignmentItemDgItems[].companyDgItemId Integer No
items[].consignmentItemDgItems[].properShippingName String No
items[].consignmentItemDgItems[].aggregateQuantity Number No
items[].consignmentItemDgItems[].subDgClassTypes[] Array No
items[].consignmentItemDgItems[].containerType Integer No

1 = Drum, 2 = Carton, 3 = IBC, 4 = Pail, 5 = DemountableTank, 6 = Bottle, 7 = PressureDrums, 8 = Tubes, 9 = MEGCs, 10 = Aerosol, 11 = Bag

Possible values:

  • 11
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
items[].consignmentItemDgItems[].isAggregateQuantityWeight Boolean No
items[].consignmentItemDgItems[].isEmptyDgContainer Boolean No
items[].consignmentItemDgItems[].isMarinePollutant Boolean No
items[].consignmentItemDgItems[].numberOfContainers Integer No
items[].consignmentItemDgItems[].technicalOrChemicalGroupNames String No
items[].consignmentItemDgItems[].isTemperatureControlled Boolean No
items[].companyItemId Integer No

Optional: Links this item back up to a saved item in Machship
items[].palletSpaces Number No
consignmentId Integer No
carrierServiceId Integer No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy