Create a shipment for an invoice belonging to one of your sub-merchants.
Request body for creating a new shipment.
ID of the invoice this shipment belongs to. The invoice must belong to one of your sub-merchants.
Method of fulfillment for the shipment. Determines what additional fields are required:
shipping_provider: Requiresshipment_tracking_numberandshipment_courier. File is not allowed.self_delivery,customer_pickup,services_only: Require afile. Tracking number and courier are optional.
Tracking number (required when fulfillment_method is shipping_provider, optional otherwise).
Shipping courier (required when fulfillment_method is shipping_provider, optional otherwise). While any value can be accepted, instant verification is supported for specific couriers.
See the Shipments API documentation for the complete list of supported couriers.
Proof of delivery file. Required for self_delivery, customer_pickup, and services_only fulfillment methods. Forbidden for shipping_provider fulfillment method.
Use the /shipments/sign-upload endpoint to obtain a signed URL for uploading the file to S3, then include the uploaded file details here.
{ "url": "https://bucket.s3.amazonaws.com/1234567890-document.pdf", "size": 204800, "metadata": { "original_filename": "proof_of_delivery.pdf" } }
- Mock serverhttps://docs.resolvepay.com/_mock/partners-api/openapi/shipments
- Sandbox serverhttps://app-sandbox.resolvepay.com/api/shipments
curl -i -X POST \
https://docs.resolvepay.com/_mock/partners-api/openapi/shipments \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"merchant_invoice_id": "inv_1234567890abcdef",
"fulfillment_method": "shipping_provider",
"shipment_tracking_number": "1Z123E45678901234",
"shipment_courier": "ups",
"send_email": true,
"file": {
"url": "https://bucket.s3.amazonaws.com/1234567890-document.pdf",
"size": 204800,
"metadata": {
"original_filename": "proof_of_delivery.pdf"
}
}
}'An object representing the Shipment.
Method of fulfillment for the shipment.
Tracking number provided by the shipping courier.
Shipping courier or provider name. While any value can be accepted, instant verification is supported for specific couriers.
See the Shipments API documentation for the complete list of supported couriers.
Manual or automatic verification status of the shipment.
Date time when the shipment was last updated.
Current tracking status of the shipment from the courier.
Detailed tracking substatus providing additional context about the shipment's current state.
{ "id": "ship_1234567890abcdef", "merchant_invoice_id": "inv_1234567890abcdef", "fulfillment_method": "shipping_provider", "shipment_tracking_number": "1Z123E45678901234", "shipment_courier": "ups", "verification_status": "verified", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T14:45:00Z", "tracking_status": "delivered", "tracking_substatus": "delivered_001", "expected_delivery": "2024-01-20T18:00:00Z" }