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

POST /apiv2/pendingConsignments/createPendingConsignment

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
toCountryId Integer No

MachShip assigned ID of the destination country.
despatchDateTimeLocal String No

Optional: The local despatch datetime that was provided in the route. This datetime must be local to the pickup location. If the DespatchDateTimeUtc is provided, this does not need to be set. If no time is set, this will default to NOW (pickup local time)
internationalFromCity String No

International from city.
carrierAccountId Integer No
fromName String No
internationalFromPostcode String No

International from postcode.
fromCountryCode String No

Two or three letter ISO code of the country of origin.
fromCompanyLocationId Integer No

The Machship Id of the saved company location that you want to use. If this is provided, Machship will link this consignment to your saved location and you do not have to provide the delivery details
toContact String No
internationalToProvince String No

International to province.
customerReference String No
questionIds[] Array No
isReceiverAccount Boolean No
printerToken String No
companyId Integer No

An (optional) Machship ID of a company. When supplied the routes will be those of the company specified, when left blank they will be routes for the company associated with the authorised user.
toName String No
isInternational Boolean No

Flag to indicate if this consignment is international.
fromAddressLine2 String No
fromAddressLine1 String No
carrierConsignmentId String No
carrierService String No

Abbreviation of the CarrierService that you would like to create a consignment for. This should only be provided if carrier service id could not be determined via routing
toCompanyLocationId Integer No

The Machship Id of the saved company location that you want to use. If this is provided, Machship will link this consignment to your saved location and you do not have to provide the delivery details
fromCountry Object No
fromCountry.id Integer No
fromCountry.currencyCode String No
fromCountry.name String No
fromCountry.numeric String No
fromCountry.taxPercentage Number No
fromCountry.displayName String No
fromCountry.code3 String No
fromCountry.code2 String No
fromPhone String No
fromLocation Object No
fromLocation.suburb String No
fromLocation.postcode String No
fromLocationId Integer No

The machship ID of the from (pickup) location. Can be left blank if supplying the suburb / postcode instead
fromAbbreviation String No
staffMemberName String No
carrierAccount String No

Abbreviation of the CarrierAccount that you would like to create a consignment for. This should only be provided if carrier account id could not be determined via routing
fromContact String No
customValues[] Array No
customValues[].propertyName String No
customValues[].value String No
companyCarrierAccountId Integer No
items[] Array No
items[].height Number No

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

Volume of the item
items[].width Number No

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

Number of items
items[].carrierReference String No

The carrier reference of the item
items[].pendingConsignmentItemDgItems[] Array No
items[].pendingConsignmentItemDgItems[].packingGroup Integer No

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

Possible values:

  • 1
  • 2
  • 3
  • 4
items[].pendingConsignmentItemDgItems[].unNumber Integer No
items[].pendingConsignmentItemDgItems[].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[].pendingConsignmentItemDgItems[].companyDgItemId Integer No
items[].pendingConsignmentItemDgItems[].properShippingName String No
items[].pendingConsignmentItemDgItems[].aggregateQuantity Number No
items[].pendingConsignmentItemDgItems[].subDgClassTypes[] Array No
items[].pendingConsignmentItemDgItems[].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[].pendingConsignmentItemDgItems[].isAggregateQuantityWeight Boolean No
items[].pendingConsignmentItemDgItems[].isEmptyDgContainer Boolean No
items[].pendingConsignmentItemDgItems[].id Integer No
items[].pendingConsignmentItemDgItems[].isMarinePollutant Boolean No
items[].pendingConsignmentItemDgItems[].numberOfContainers Integer No
items[].pendingConsignmentItemDgItems[].technicalOrChemicalGroupNames String No
items[].pendingConsignmentItemDgItems[].isTemperatureControlled Boolean No
items[].pendingConsignmentItemDgItems[].pendingConsignmentItemId Integer No
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[].name String No

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

the SKU or code of the item you are sending
items[].length Number No

Length of the item in cm
items[].companyItemId Integer No

Links this item back up to a saved item in Machship
items[].pendingConsignmentItemReferences[] Array No
items[].pendingConsignmentItemReferences[].id Integer No
items[].pendingConsignmentItemReferences[].carrierItemReference String No
items[].pendingConsignmentItemReferences[].carrierReference String No
items[].pendingConsignmentItemReferences[].pendingConsignmentItemId Integer No
items[].pendingConsignmentItemReferences[].itemNumber Integer No
items[].weight Number No

Weight of the item in kg
items[].palletSpaces Number No
internationalToPostcode String No

International to postcode.
toLocation Object No
toLocation.suburb String No
toLocation.postcode String No
toCountryCode String No

Two or three letter ISO code of the destination country.
fromEmail String No
carrierServiceId Integer No

Abbreviation of the Carrier that you would like to create a consignment for. This should only be provided if carrier id could not be determined via routing
toLocationId Integer No

The machship ID of the to (receiver) location. Can be left blank if supplying the suburb / postcode instead
companyCarrierAccount String No

Abbreviation of the CompanyCarrierAccount that you would like to create a consignment for. This should only be provided if company carrier account id could not be determined via routing
sendTrackingEmail Boolean No
toAbbreviation String No
toCountry Object No
toCountry.id Integer No
toCountry.currencyCode String No
toCountry.name String No
toCountry.numeric String No
toCountry.taxPercentage Number No
toCountry.displayName String No
toCountry.code3 String No
toCountry.code2 String No
carrierId Integer No
carrier String No
toEmail String No
fromCountryId Integer No

MachShip assigned ID of the country of origin.
toAddressLine2 String No
internationalFromProvince String No

International from province.
toAddressLine1 String No
receiverAccountCode String No
internationalToCity String No

International to city.
customerReference2 String No
specialInstructions String No
toPhone String 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