POST /apiv2/consignments/createConsignment

Creates an unmanifested consignment in Machship

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
`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)
`carrierAccountId`	Integer	No
`fromName`	String	No
`initialPricingRouteRequestId`	String	No	Optional: The route request ID from the initial pricing/route search performed in the UI. This is used for tracing which route request the user was viewing when they created the consignment.
`subServiceId`	Integer	No	The Machship ID of the sub-service under the carrier's service (if there are any). If there are sub-services and this field is left blank, the default will be selected
`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
`isReturn`	Boolean	No	Optional, default false. Marks this consignment as a customer return, and is required on every return booking. On its own it books a pickup: the From address on this request is the collection point and is left as supplied. Combined with `returnsDepotId` it books a drop-off and the From is taken from the depot. Requires the returns-dropoffs feature to be enabled for your account. Default value: false
`customerReference`	String	No
`limitedQuantityDgsDeclaration`	Boolean	No
`questionIds[]`	Array	No	A collection of Machship IDs corresponding to questions who's result is true
`despatchDateTimeUtc`	String	No	Optional: The UTC despatch datetime that was provided in the route. If the DespatchDateTimeLocal is provided, this does not need to be set. If no time is set, it will default to NOW (UTC)
`printerToken`	String	No	If this corresponds to a printer token, will automatically print the consignment to the associated printer
`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
`fromAddressLine2`	String	No
`fromAddressLine1`	String	No
`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
`fromPhone`	String	No
`linkedPendingConsignmentIds[]`	Array	No	Optional list of Machship Pending Consignment ID(s) to link to this consignment - these pending consignment(s) will be linked to this consignment and effectively be deleted from Machship
`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
`parentConsignmentId`	Integer	No
`fromAbbreviation`	String	No
`returnsDepotId`	Integer	No	Optional. The returns drop-off depot the quoted option was priced from — echo the `returnsDepotId` of the chosen option from the returns quote response. When supplied, the consignment's pickup is taken from that depot and any From fields on this request are overridden. Requires `isReturn`.
`staffMemberName`	String	No
`fromContact`	String	No
`customValues[]`	Array	No
`customValues[].propertyName`	String	No
`customValues[].value`	String	No
`companyCarrierAccountId`	Integer	No
`receiverAccountId`	Integer	No
`items[]`	Array	Yes	A collection of the items being sent
`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[].height`	Number	No	Height of the item in cm
`items[].length`	Number	No	Length of the item in cm
`items[].width`	Number	No	Width of the item in cm
`items[].quantity`	Integer	No	Number of items
`items[].companyItemId`	Integer	No	Optional: Links this item back up to a saved item in Machship
`items[].weight`	Number	No	Weight of the item in kg
`items[].palletSpaces`	Number	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, 62 = MhpItem, 63 = Length, 64 = ChepIbc, 65 = LoscamIbc, 66 = ChepDisplay, 67 = LoscamDisplay, 68 = ChepM3Palletcon, 69 = LoscamM3Palletcon, 70 = ChepUnicon, 71 = LoscamUnicon, 72 = ChepIbcI6, 73 = LoscamIbcI6, 74 = FortyEightFootContainer, 75 = Bottle Valid 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` `62` `63` `20` `64` `21` `65` `22` `66` `23` `67` `24` `68` `69` `26` `27` `28` `29` `70` `71` `72` `73` `30` `74` `31` `75` `32` `33` `34` `35` `36` `37` `38` `39` `40` `41` `42` `43`
`dgsDeclaration`	Boolean	No	This must be set to true if the consignment contains Dangerous Goods. If this consignment does not have Dangerous Goods, this must be set to false. Note this flag only needs to be set if you are setup to consign Dangerous Goods through Machship
`toLocation`	Object	No
`toLocation.suburb`	String	No
`toLocation.postcode`	String	No
`fromEmail`	String	No
`carrierServiceId`	Integer	No
`toLocationId`	Integer	No	The machship ID of the to (receiver) location. Can be left blank if supplying the suburb / postcode instead
`previousConsignmentId`	Integer	No
`toAbbreviation`	String	No
`carrierId`	Integer	No
`toEmail`	String	No
`consignmentOptions`	String	No
`toAddressLine2`	String	No
`defaultRouteSelection`	Integer	No	0 = Cheapest, 1 = Fastest Valid values: `0` `1`
`electiveSurchargeIds[]`	Array	No
`toAddressLine1`	String	No
`receiverAccountCode`	String	No
`customerReference2`	String	No
`specialInstructions`	String	No
`sendingTrackingEmail`	Boolean	No	Set this to true if you would like to send a tracking email to the receiver email address once this consignment is manifested
`toPhone`	String	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.