POST /apiv2/consolidation/performConsolidation

Default value: "application/json"

Set this flag to true when you do not want to consolidate, rather you just want the consignments to be returned to be abl to perform a bulk update

Which type of consignments to target for consolidation0 = Unmanifested, 1 = Pending, 2 = Both

Possible values:

• 0
• 1
• 2

Whether the first customer reference be used when grouping consignments for consolidation

Whether the service will be considered when consolidating consignments (only relevant when Machship.Common.Models.Consolidation.ConsolidationOptions.GroupByCarrier is also set to true)

The Machship Company ID that consolidation should be performed for - if omitted it will be performed against the company of the user performing consolidation

Whether the second customer reference be used when grouping consignments for consolidation

Whether the carrier will be considered when consolidating consignments

0 = Cheapest, 1 = Fastest

Possible values:

• 0
• 1

0 = DoNotConsolidateOnAnyError, 1 = ConsolidateValidConsignments

Possible values:

• 0
• 1

Optional - list of pending consignment IDs to attempt to consolidate. Will not be considered if Machship.Common.Models.Consolidation.ConsolidationOptions.ConsolidationTarget is set to Machship.Common.Models.Consolidation.Enums.ConsolidationTarget.Unmanifested. If omitted all pending consignments will be used to attempt consolidation.

Whether the despatch date be used when grouping consignments for consolidation

Optional - list of unmanifested consignment IDs to attempt to consolidate. Will not be considered if Machship.Common.Models.Consolidation.ConsolidationOptions.ConsolidationTarget is set to Machship.Common.Models.Consolidation.Enums.ConsolidationTarget.Pending. If omitted all unmanifested consignments will be used to attempt consolidation.

The consolidated consignments and their details

Number of items

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

Height of the item in cm

Length of the item in cm

Width of the item in cm

Weight of the item in kg

This is populated IF it is an existing unmanifested consignment's consignment item ID

Name or description of the goods you are sending

Optional: the SKU or code of the item you are sending

Total weight in kg of the combined item

Weight in kg of the heaviest individual item that comprises the combined item

Total width in cm of the combined item

Total height in cm of the combined item

Total length in cm of the combined item

Number of individual pieces that comprise the combined item

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

Possible values:

• 1
• 2
• 3
• 4

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

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

Possible values:

• 1
• 2
• 3
• 4

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

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

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

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

Optional: Links this item back up to a saved item in Machship

This is used when new consignments are being created and run through the consolidation engine - having a globally unique ID means we can match the consolidation result back up with the request

Machship's Consignment / Pending Consignment ID

Stripped back details of the Company Carrier Account

Machship's Consignment (MS) or Pending Consignment (PS) number

An address

The contact name for this address

The name of the addresss

The email address associated with this addresss

0 = Suburb, 1 = PostOfficeBox, 2 = International

Possible values:

• 0
• 1
• 2

used if the user only passed in a string for the location. Location Service will then try to find location based on str

The country code is used to determine the international location

The phone number associated with this address

The first line of the address

The (optional) second line of the address

Stripped back details of the Company Carrier Account

Machship's Consignment / Pending Consignment ID

Stripped back details of the Company Carrier Account

Machship's Consignment (MS) or Pending Consignment (PS) number

An address

The contact name for this address

The name of the addresss

The email address associated with this addresss

0 = Suburb, 1 = PostOfficeBox, 2 = International

Possible values:

• 0
• 1
• 2

used if the user only passed in a string for the location. Location Service will then try to find location based on str

The country code is used to determine the international location

The phone number associated with this address

The first line of the address

The (optional) second line of the address

When true then the consignment is never going to be sent to the carrier and exists in MachShip purely to test

Machship's Consignment / Pending Consignment ID

Stripped back details of the Company Carrier Account

Machship's Consignment (MS) or Pending Consignment (PS) number

Set this to true if you would like to send a tracking email to the receiver email address once this consignment is manifested

The Machship Company ID that consolidation should / has been performed against