This endpoint is used to update a draft shipment. If a shipment is already confirmed, then the endpoint will return a 400 error.
The shipment_id
is used as a path parameter to identify the shipment. Alternatively the merchant provided shipment reference (partner_shipment_reference
) can also be used instead of the shipment_id
.
Bad Request
{- "entity_type": "FORWARD",
- "merchant": "YOUR_MERCHANT_ID",
- "references": {
- "partner_order_reference": "string",
- "partner_shipment_reference": "string",
- "alternate_reference": "string",
- "other_references": [
- "string"
]
}, - "carrier_account": {
- "carrier_id": "string",
- "carrier_account_name": "string"
}, - "payment": {
- "payment_mode": "PRE_PAID",
- "pending_amount": 0,
- "total_amount": 0,
- "currency": "string"
}, - "collection": {
- "scheduled_date": "2022-01-01",
- "scheduled_from": "2022-01-01T10:00:000Z",
- "scheduled_to": "2022-01-01T12:00:000Z"
}, - "delivery": {
- "delivery_type": "string",
- "scheduled_from": "2019-08-24T14:15:22Z",
- "scheduled_to": "2019-08-24T14:15:22Z",
- "scheduled_date": "2019-08-24"
}, - "pickup": {
- "partner_location_id": "string",
- "partner_location_code": "string"
}, - "dropoff": {
- "contact_name": "Jo Bloggs",
- "contact_phone": 16175551212,
- "alternate_phone": 16175551210,
- "contact_email": "jo.bloggs@gmail.com",
- "address1": "1 Financial Centre Road",
- "address2": "Downtown Views, Apartment 101",
- "area": "DOWNTOWN-DUBAI",
- "city": "DUBAI",
- "state": "DUBAI",
- "postcode": "E1 6AN",
- "country": "AE",
- "coords": [
- 41.40338
], - "type": "residential",
- "notes": "Leave the parcel next to the bin",
- "what3words": "string",
- "personal_id": {
- "id": "string",
- "type": "string"
}, - "street": "string",
- "building": "string",
- "floor": "string",
- "flat": "string",
- "po_box": "string",
- "collection_point_id": "string",
- "custom_fields": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "items": [
- {
- "sku": "string",
- "description": "string",
- "barcode": "string",
- "image_link": "string",
- "quantity": 1,
- "price": {
- "amount": 0,
- "currency": "string"
}, - "cost": {
- "amount": 0,
- "currency": "string"
}, - "weight": {
- "value": 0,
- "unit": "kg"
}, - "origin_country": "string",
- "hs_code": "string",
- "dangerous_goods": true,
- "battery": {
- "material_type": "lithium_metal",
- "packing_type": "contained_in_equipment"
}, - "notes": "string"
}
], - "parcels": [
- {
- "partner_parcel_reference": "string",
- "description": "string",
- "weight": {
- "value": 0,
- "unit": "kg"
}, - "dimension": {
- "width": 0,
- "height": 0,
- "depth": 0,
- "unit": "cm"
}, - "parcel_items": [
- {
- "sku": "string",
- "quantity": 0
}
]
}
], - "freight": {
- "packages": [
- {
- "package_reference": "string",
- "type": "pallet",
- "weight": {
- "value": 0,
- "unit": "kg"
}, - "dimension": {
- "width": 0,
- "height": 0,
- "depth": 0,
- "unit": "cm"
}, - "parent": "string"
}
]
}, - "customs": {
- "declared_value": {
- "amount": 0,
- "currency": "string"
}
}, - "custom_attributes": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "order_date": "2022-01-01T09:00:00.000+1:00",
- "order_type": "HOME_DELIVERY",
- "language": "en"
}
{- "shipment_id": "XYZABC123",
- "entity_type": "FORWARD",
- "merchant": "MY_BRAND",
- "references": {
- "partner_order_reference": "string",
- "partner_shipment_reference": "string",
- "alternate_reference": "string",
- "other_references": [
- "string"
]
}, - "carrier_account": {
- "carrier": "DHL",
- "carrier_account_name": "My DHL Account",
- "carrier_id": "act_1261YQIU2eTuokipwqbNBV"
}, - "payment": {
- "payment_mode": "PRE_PAID",
- "pending_amount": 0,
- "total_amount": 0,
- "currency": "string"
}, - "collection": {
- "scheduled_date": "2022-01-01",
- "scheduled_from": "2022-01-01T10:00:000Z",
- "scheduled_to": "2022-01-01T12:00:000Z"
}, - "delivery": {
- "delivery_type": "string",
- "scheduled_date": "2022-01-01",
- "scheduled_from": "2022-01-01T10:00:000Z",
- "scheduled_to": "2022-01-01T12:00:000Z"
}, - "pickup": {
- "partner_location_id": "string",
- "contact_name": "Jo Bloggs",
- "contact_phone": 16175551212,
- "alternate_phone": 16175551210,
- "contact_email": "jo.bloggs@gmail.com",
- "address1": "1 Financial Centre Road",
- "address2": "Downtown Views, Apartment 101",
- "area": "DOWNTOWN-DUBAI",
- "input_area": "Downtown Dubai",
- "area_coords": [
- 0
], - "city": "DUBAI",
- "input_city": "Dubai",
- "city_coords": [
- 0
], - "state": "DUBAI",
- "input_state": "Dubai",
- "postcode": "E1 6AN",
- "country": "AE",
- "coords": [
- 41.40338
], - "type": "residential",
- "notes": "Leave the parcel next to the bin",
- "what3words": "string",
- "personal_id": {
- "id": "string",
- "type": "string"
}, - "street": "string",
- "building": "string",
- "floor": "string",
- "flat": "string",
- "po_box": "string",
- "collection_point_id": "string",
- "custom_fields": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "dropoff": {
- "partner_location_id": "string",
- "contact_name": "Jo Bloggs",
- "contact_phone": 16175551212,
- "alternate_phone": 16175551210,
- "contact_email": "jo.bloggs@gmail.com",
- "address1": "1 Financial Centre Road",
- "address2": "Downtown Views, Apartment 101",
- "area": "DOWNTOWN-DUBAI",
- "input_area": "Downtown Dubai",
- "area_coords": [
- 0
], - "city": "DUBAI",
- "input_city": "Dubai",
- "city_coords": [
- 0
], - "state": "DUBAI",
- "input_state": "Dubai",
- "postcode": "E1 6AN",
- "country": "AE",
- "coords": [
- 41.40338
], - "type": "residential",
- "notes": "Leave the parcel next to the bin",
- "what3words": "string",
- "personal_id": {
- "id": "string",
- "type": "string"
}, - "street": "string",
- "building": "string",
- "floor": "string",
- "flat": "string",
- "po_box": "string",
- "collection_point_id": "string",
- "custom_fields": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "items": [
- {
- "sku": "string",
- "description": "string",
- "barcode": "string",
- "image_link": "string",
- "quantity": 1,
- "price": {
- "amount": 0,
- "currency": "string"
}, - "cost": {
- "amount": 0,
- "currency": "string"
}, - "weight": {
- "value": 0,
- "unit": "kg"
}, - "origin_country": "string",
- "hs_code": "string",
- "dangerous_goods": true,
- "notes": "string"
}
], - "freight": {
- "packages": [
- {
- "package_reference": "string",
- "type": "pallet",
- "weight": {
- "value": 0,
- "unit": "kg"
}, - "dimension": {
- "width": 0,
- "height": 0,
- "depth": 0,
- "unit": "cm"
}, - "parent": "string"
}
]
}, - "customs": {
- "declared_value": {
- "amount": 0,
- "currency": "string"
}
}, - "parcels": [
- {
- "parcel_id": "string",
- "partner_parcel_reference": "string",
- "description": "string",
- "weight": {
- "value": 0,
- "unit": "kg"
}, - "dimension": {
- "width": 0,
- "height": 0,
- "depth": 0,
- "unit": "cm"
}, - "parcel_items": [
- {
- "sku": "string",
- "quantity": 0
}
]
}
], - "post_shipping_info": {
- "status": "string",
- "reason_code": "string",
- "carrier_status": "string",
- "carrier_status_description": "string",
- "carrier_status_date": "2019-08-24T14:15:22Z",
- "carrier_status_location": "string",
- "tracking_no": "string",
- "parcel_tracking_numbers": [
- {
- "parcel_id": "string",
- "tracking_number": "string"
}
], - "default_label_url": "string",
- "carrier_pdf_label_url": "string",
- "carriyo_pdf_label_url": "string",
- "carriyo_zpl_label_url": "string",
- "carrier_tracking_url": "string",
- "carriyo_tracking_url": "string",
- "carriyo_feedback_url": "string",
- "carriyo_pinpoint_url": "string",
- "driver_name": "string",
- "driver_phone": "string",
- "recipient_name": "string",
- "proof_of_delivery": "string",
- "key_milestones": {
- "pending": "string",
- "error": "string",
- "booked": "string",
- "ready_to_ship": "string",
- "cancelled": "string",
- "cancelled_by_carrier": "string",
- "failed_collection_attempt": "string",
- "shipped": "string",
- "in_transit": "string",
- "out_for_delivery": "string",
- "awaiting_customer_collection": "string",
- "delivered": "string",
- "delivery_confirmed": "string",
- "failed_delivery_attempt": "string",
- "ready_for_return": "string",
- "return_in_transit": "string",
- "returned": "string",
- "return_confirmed": "string",
- "suspended": "string",
- "missing": "string",
- "delayed": "string"
}, - "failed_delivery_attempts": 0,
- "estimated_delivery_date": "2019-08-24T14:15:22Z",
- "estimated_ship_date": "2019-08-24T14:15:22Z",
- "error_details": [
- {
- "level": "string",
- "code": "string",
- "field": "string",
- "message": "string",
- "source": "string",
- "trigger": "string",
- "type": "string"
}
], - "documents": [
- {
- "name": "string",
- "type": "string",
- "source": "string",
- "format": "string",
- "url": "string"
}
]
}, - "custom_attributes": { },
- "order_date": "2022-01-01T09:00:00.000Z",
- "order_type": "HOME_DELIVERY",
- "creation_date": "2022-01-01T09:00:00.000Z",
- "update_date": "2022-01-01T09:00:00.000Z",
- "confirmation_date": "2022-01-01T09:00:00.000Z",
- "estimated_process_date": "2019-08-24T14:15:22Z",
- "promised_delivery_date": "2022-01-01T09:00:00.000Z",
- "original_promised_delivery_date": "2022-01-01T09:00:00.000Z",
- "estimated_shipping_cost": {
- "amount": 10,
- "currency": "USD",
- "breakdown": [
- {
- "amount": 10,
- "currency": "USD",
- "description": "Total VAT Charge"
}
]
}, - "language": "en",
- "rma_id": "rma_123abcXYZ"
}