How to Manifest via the MachShip API
## Current Content
This article has been moved to our developer handbook and can be found here:
For detailed information on the `pickupAlreadyBooked` field and its impact on pickup notifications, see the companion documentation below.
### pickupAlreadyBooked Field Behavior
The `pickupAlreadyBooked` field controls whether MachShip sends pickup booking notifications to carriers when consignments are manifested. This field is essential for implementing location-based pickup strategies where different locations may require different notification approaches.
#### Field Behavior
- **When `pickupAlreadyBooked` is set to `false`**: MachShip will send an individual pickup booking notification to the carrier upon manifest. Use this setting when a location requires per-consignment pickup notifications.
- **When `pickupAlreadyBooked` is set to `true` or omitted (default)**: MachShip will NOT send a per-consignment pickup notification. Use this setting for locations that use daily standing collections or have pickups already arranged.
#### Use Cases
This field is particularly useful for location-based pickup strategies where:
- Some locations use daily standing collections (set `pickupAlreadyBooked` to `true` or omit the field)
- Other locations require individual per-consignment pickup notifications (set `pickupAlreadyBooked` to `false`)
#### Example JSON Payloads
**Scenario 1: Per-consignment pickup notification required**
```json
{
"consignmentNumber": "CONS123456",
"pickupAlreadyBooked": false,
"carrier": "BorderExpress",
"location": "Moorebank"
}
```
In this scenario, MachShip will send an individual pickup booking notification to Border Express upon manifest.
**Scenario 2: Daily standing collection (no per-consignment notification)**
```json
{
"consignmentNumber": "CONS123457",
"pickupAlreadyBooked": true,
"carrier": "BorderExpress",
"location": "Sydney"
}
```
In this scenario, MachShip will NOT send a per-consignment pickup notification, as the pickup is already arranged through a standing collection agreement.
Related Articles
Auto-Consolidation Via The MachShip API
What is auto-consolidation? Auto-consolidation is a feature of Machship that is enabled on a per carrier basis, where we combine newly created consignments into existing consignments at the point they are created, rather than making a new ...
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 ...
Creating Pending Consignments using the MachShip API
This guide has been moved to our developers handbook and can be found here: Creating Pending Consignments Via The MachShip API
A guide to creating Dangerous Goods Consignments via the API
This article has been moved to our developer handbook and can be found here: Creating Dangerous Goods Consignments via the MachShip API
Machship API Integration Workflow Guide
This article has now been moved to the Developer Handbook. Please see the related links below: Getting Started with Your MachShip Integration Integration Workflows MachShip API Overview