Machship

Downloads the raw Attachment file

Downloads the POD report which includes the attachment and details about the consignment

Downloads attachments given a list of up to 40 consignments

Determine whether a user is logged in and get any session properties required by the front end

Attempt to auto reconcile consignments based on the thresholds defined in the carrier account associated with the consignment. Note that a successful response from this function will not indicate whether the consignments did or did not auto-reconcile - you will need to establish that from the consignments and their notes instead.

Return the basic information about carrier invoices that have been imported into Machship. It will return at most 100 records, in the order of most recently imported to oldest.

Get a listing of carrier invoice entries for a particular carrier invoice, with the option to filter by the status of the entries.

Update a consignment's items and trigger Machship to reprice it using the new item weights / dimensions.

Get all companies that the current user can access

Get all available carriers with accounts and services

Create a new company location against a company

Edit a company location

Creates an unmanifested consignment in Machship

Deletes the specified Unmanifested Consignments in Machship

Edit a consignment - note that it must be in an "unmanifested" state for this to be a valid operation

Return all consignments for a company, regardless of status

Gets attachment information for a given consignment

Returns consignments for the given company that were completed within the provided start and end date range. Limited to 2000 consignments at a time.

Get Consignment Details for a single consignment

Get a Consignment Details (if it exists) for a single consignment, using a pending consignment ID that has been transformed (linked) into a consignment

Get the details of an existing consignment in a format that can be passed to the createConsignmentWithComplexItems endpoint

Return consignments for a company that have been created or updated within the timeframe specified

Get all consignments for a company that are in an "unmanifested" state

Get an unmanifested consignment in the same format required to perform an update in the edit endpoint

Get Consignment Details for a multiple consignments. Maximum of 100 consignments per request

Get Consignment Details for a multiple consignments using the Carrier Consignment ID as the lookup. Maximum of 10 consignments per request

Get Consignment Details for multiple consignments using the Pending Consignment Id as the lookup. Maximum of 100 consignments.

Get Consignment Details for a multiple consignments using Reference 1 as the lookup. Maximum of 10 consignments per request

Get Consignment Details for a multiple consignments using Reference 2 as the lookup. Maximum of 10 consignments per request

Return all statuses recorded in the system with an option to specify a cutoff date to limit the statuses returned to ones saved in Machship after a certain date. Maximum of 100 consignments

Get the details of related consignments based on the provided list of consignment or item references

Do both the grouping into auto consolidation as well as the routing and updating of consolidated consignments

Perform automatic grouping on unmanifested and / or pending consignments/orders

Consolidate consignments from other consignments / pending consignments/orders into a combined unmanifested consignment

Return the basic information about invoices that are in a posted state. It will return at most 100 records, in the order of most recently imported to oldest.

Returns invoice details with the invoice pdf as a byte array

Create Identities in MachShip and assign companies and roles to identities to give them access to the system. Note that all identities provided must belong to the same identityProvider and organisation You must be an administrator of the organisation in question to be able to access this endpoint.

Get all roles that are available to assign users of a certain company

Get all identities owned by an organisation, along with details on which company they are linked to. You must be an administrator of the organisation in question to be able to access this endpoint.

Assign companies and roles to identities to give them access to the system. You must be an administrator of the organisation in question to be able to access this endpoint.

Get the "public keys" of the supplied identities that can be used by another organisation (that has been linked to the organisation owning the identity) to give that identity access to a company in their organisation. You must be an administrator of the organisation in question to be able to access this endpoint.

Returns all the identity providers for your current organisation

Returns all the identity providers for the specified organisation

Returns a saved item with all its dimensions

Returns a list of items for a given company. By default, it will return the top 200 items. If you have more than 200, you will need to enter a different startIndex. Eg. 201, 401, etc. This only returns standard items

Returns a list of items for a given company. By default, it will return the top 200 items. If you have more than 200, you will need to enter a different startIndex. Eg. 201, 401, etc. Returns all items as complex items

Returns a saved item that has the matching Sku. This only returns simple items

Returns a saved item that has the matching Sku. Returns complex items

Returns a saved complex item with all its dimensions

Gets item labels as a zip for up to 40 consignments

Returns item labels as a zip for up to 40 consignments

Returns all locations that exactly match the supplied suburb and postcode combination. Multiple locations can be provided

Get a list of (up to 200) manifests for a company.

Groups all unmanifested consignments for a company into manifests.

Groups a set of consignments into manifests.

Take the public key of an organisation and "link it into" an organisation you are an administrator of. Doing this allows you to assign users from the other organisation into companies in your organisation.

Returns all the links that exist for the organisation

Returns all the from linked organisations that exist for the organisation

Returns all the to linked organisations that exist for the organisation

Test a public key and, if it is correct, return details on which organisation it corresponds to

Return this organisation's "public key" - which can be given to other organisations to link the organisation "into" the other - meaning that users can be invited into the other organisation to access their data.

Remove an existing link between organisations. Note that doing this will remove access to the "to" organisation from any users of the "from" organisation, and that this is irreversable.

Resets the organisation's public key. Note that this will not reset any organisation links set up via the old public key.

Creates a pending consignment in Machship

Deletes the specified Pending Consignments in Machship

Get Pending Consignment Details for a single pending consignment

Get Pending Consignment Details for multiple pending consignments. Maximum of 10 per request

Get Pending Consignment Details for multiple pending consignments using Reference 1 as the lookup. Maximum of 10 per request

Get Pending Consignment Details for multiple pending consignments using Reference 2 as the lookup. Maximum of 10 per request

Creates a quote in Machship

Get All quotes for the given company

Get Quote Details for a single quote

Returns a list of available routes corresponding to supplied the route requests

Returns a list of available routes corresponding to supplied the route request

Operations