POST /apiv2/quotes/createQuote
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 |
|---|---|---|---|
staffMemberName |
String | No | |
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) |
fromContact |
String | No | |
carrierAccountId |
Integer | No | |
companyCarrierAccountId |
Integer | No | |
fromName |
String | 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 Possible values:
|
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 | |
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 |
customerReference |
String | No | |
toLocation |
Object | No | |
toLocation.suburb |
String | No | |
toLocation.postcode |
String | No | |
fromEmail |
String | No | |
carrierServiceId |
Integer | No | |
questionIds[] |
Array | No |
A collection of Machship IDs corresponding to questions who's result is true |
toLocationId |
Integer | No |
The machship ID of the to (receiver) location. Can be left blank if supplying the suburb / postcode instead |
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) |
previousConsignmentId |
Integer | No | |
toAbbreviation |
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. |
carrierId |
Integer | No | |
toName |
String | No | |
fromAddressLine2 |
String | No | |
toEmail |
String | No | |
fromAddressLine1 |
String | No | |
consignmentOptions |
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 | |
fromLocation |
Object | No | |
fromLocation.suburb |
String | No | |
fromLocation.postcode |
String | No | |
toAddressLine2 |
String | No | |
defaultRouteSelection |
Integer | No |
0 = Cheapest, 1 = Fastest Possible values:
|
electiveSurchargeIds[] |
Array | No | |
toAddressLine1 |
String | No | |
receiverAccountCode |
String | No | |
fromLocationId |
Integer | No |
The machship ID of the from (pickup) location. Can be left blank if supplying the suburb / postcode instead |
customerReference2 |
String | No | |
parentConsignmentId |
Integer | No | |
fromAbbreviation |
String | No | |
specialInstructions |
String | No | |
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.