Creating Benign or Existing Consignments Via The API

Creating Benign or Existing Consignments Via The API

Benign or existing consignments are consignments created in Machship purely for the purpose of tracking and reporting - they cannot be manifested and no data is sent to the carriers.

Endpoint: POST https://live.machship.com/apiv2/consignments/createExistingConsignment
Full schema for this endpoint is available here in the Consignments section: https://live.machship.com/swagger/index.html

Example Payloads
Majority of the fields on this payload are discussed in detail on our createConsignment article available here.

{
  "companyId": 0, //business unit in Machship - only needed if you have several

  "items": [
    {
      "itemType": "Carton",
      "name": "test",
      "quantity": 1,
      "standardItem": {
        "height": 0,
        "weight": 0,
        "length": 0,
        "width": 0
      }
    }
  ],
  "fromName": "My Warehouse",
  "fromContact": "Bob Jones",
  "fromPhone": "123123123",
  "fromEmail": "test@test.com",
  "fromAddressLine1": "testAddressLine1",
  "fromAddressLine2": "testAddressLine2",
  "fromLocation": {
    "suburb": "melbourne",
    "postcode": "3000"
  },
  "toName": "Customers House",
  "toContact": "Stacy Smith",
  "toPhone": "123123123",
  "toEmail": "test@test.com",
  "toAddressLine1": "testAddressLine1",
  "toAddressLine2": "testAddressLine2",
  "toLocation": {
    "suburb": "Sydney",
    "postcode": "2000"
  },
  "specialInstructions": "leave at front door"

  //tracking information
  "statusId": 1, //list below this payload

  "carrierConsignmentId": "ABC123",
  "completedDate": "2024-03-25T06:56:56.418Z", //only required if the consignment has been delivered
  "despatchDateTimeUtc": "2024-03-25T06:56:56.418Z",
  "despatchDateTimeLocal": "2024-03-25T06:56:56.418Z", //Local OR Utc is fine

  //pricing information
  "totalSellPrice": 0,
  "totalCostPrice": 0,
  "totalBaseSellPrice": 0,
  "totalBaseCostPrice": 0,
  "totalTaxSellPrice": 0,
  "totalTaxCostPrice": 0,
  "costFuelLevyPrice": 0,
  "sellFuelLevyPrice": 0,
  "consignmentRouteCostPrice": 0,
  "consignmentRouteSellPrice": 0,

  //only needed for international consignments
  "isInternational": true,
  "internationalFromCity": "string",
  "internationalFromPostcode": "string",
  "internationalFromProvince": "string",
  "fromCountryCode": "string",
  "internationalToCity": "string",
  "internationalToPostcode": "string",
  "internationalToProvince": "string",
  "toCountryCode": "string",
}


  //List of status values:
  2 = Unmanifested, 3 = Manifested, 4 = Booked, 5 = InTransit, 6 = Delayed, 7 = Complete, 8 = Lost, 9 = Damaged, 10 = Cancelled, 13 = OnForDelivery, 14 = AddedToMachship, 15 = PickedUp, 16 = ScannedIntoDepot, 17 = DeliveryAttempted, 18 = SortedForDelivery, 19 = PartialDelivery, 20 = DeliveryTimeScheduled, 21 = Deleted, 22 = AtDelivery, 23 = PartialOnForDelivery, 24 = AtPickup, 25 = Manifesting, 26 = TrackingExpired, 27 = FailedPickup, 28 = FailedDelivery, 29 = AwaitingCollection, 30 = CompleteReturnedToSender

    • Related Articles

    • A guide to creating Consignments via the API

      Creating consignments is at the core of MachShip's functionality. Consignments describe everything related to a job that needs to travel including the pick-up location, delivery location and the individual items themselves. On top of this, a ...

    • A guide to creating Dangerous Goods Consignments via the API

      Creating consignments is at the core of MachShip's functionality. Consignments describe everything related to a job that needs to travel including the pick-up location, delivery location and the individual items themselves. On top of this, a ...

    • Creating Pending Consignments using the MachShip API

      One of the key efficiency targets for any business is to cut out manual tasks and automate as many processes as possible. In the Supply Chain and Logistics sector, a key blocker to this achievement is having prior knowledge of the final shipping ...

    • How to Edit Consignments Via The API

      The following article will cover how to edit a consignment via the API. The main use cases for an edit workflow include: Adjusting item weights/dimensions Adding new items Removing items Note: This article will not cover the basics of creating ...

    • How to Create Consignments Via The API With Your Own Consignment Ids and Item References

      The following article will cover how to create a consignment via the API when you are delegating your own carrier consignment numbers and item references/barcodes. This is an advanced topic, and requires the generation of fully compliant carrier ...