Editing Consignments When Setting Item References (Barcodes) This guide explains how to edit consignments when you are setting your own carrier consignment numbers and item references/barcodes. Common edit operations include: Adjusting item weights/dimensions Adding new items and references Removing items and references This guide is specifically for workflows where you manage carrier consignment IDs and item references/barcodes. For standard editing workflows, see […] Read more »
Editing Consignments via the API Overview This guide explains how to edit existing consignments using the MachShip API. Common edit operations include: Adjusting item weights/dimensions Adding new items Removing items This guide covers standard editing workflows where MachShip manages carrier consignment IDs and item references/barcodes. For editing consignments when delegating your own item references, see our Delegated References Guide. Prerequisites […] Read more »
Creating a Consignment via API with Your Own Carrier Consignment ID and Item References/Barcodes The following article covers how to create a consignment via the API when you are delegating your own carrier consignment numbers and/or item references/barcodes. Terms Carrier Consignment ID – is the consignment reference that is passed to the carrier as the identifier for the shipment Also known as: connote, carrier consignment number. Item Reference – […] Read more »
Receiver & Third-Party Pays Overview MachShip supports charging consignments to a third party or receiver instead of the sender. This guide explains how to create receiver-pays consignments using the MachShip API. Implementation Required Fields To create a receiver-pays consignment, you must provide EITHER: receiverAccountCode: The receiver’s account code with the carrier receiverAccountId: The saved receiver account ID in MachShip […] Read more »
Changing Consignment Status Via API Overview MachShip provides the ability to manually update consignment statuses through the API. A “manual” status is one that is not triggered from an external carrier’s system but rather one that has come to MachShip from its own API, or the interface. Limitations There are several important limitations to consider when updating consignment statuses: Only […] Read more »
Common API Error Responses Overview MachShip does its best to return meaningful error messages when there is something wrong with the API calls. Error Response Format If there is any error, MachShip will return a response that looks similar to the one below: { "object": null, "errors": [ { "validationType": "Error", "memberNames": [], "errorMessage": "ConsignmentIds are required" } ] […] Read more »
Creating Consignments Via The MachShip API Overview What is a Consignment? A consignment is a comprehensive description of a shipping job, including: From Address To Address Full package details Carrier selection (or routing preference) All required reference information What a consignment is not: Not a Price Quote – If you’re looking to generate prices for different shipping options, you should use […] Read more »
Finding Your Company ID Overview Many MachShip API operations require a company ID. This guide explains how to locate your company ID through the MachShip interface, or the API. In The MachShip UI Navigate to the Admin tab Under the Companies section, select View Companies Use the general Search text box to locate your company Click the cog button […] Read more »
Printing Labels & Documents Overview The printing of labels and documents in MachShip is typically handled in three ways: MachShip generates the labels, and sends them to a printer in the warehouse via the MachShip Printer App MachShip generates the labels, and you download them to your system, and manage printing internally You generate the labels yourself – you […] Read more »
Creating Dangerous Goods Consignments via the MachShip API Overview Welcome to the guide on creating dangerous goods (DG) consignments using the MachShip API. This document serves as a companion to our main guide on Creating Consignments and focuses specifically on the additional considerations and steps required when shipping dangerous goods. Understanding DG Consignments Dangerous goods consignments are shipments that contain hazardous items requiring […] Read more »
