Skip to content
Partners API/
/
Update a Shipment

Update a Shipment

Request

Update an existing shipment belonging to one of your sub-merchants.

Security
bearerAuth or basicAuth
Path
shipment_idstringrequired

ID of the Shipment to update

Example:ship_1234567890abcdef
Bodyapplication/jsonrequired

Request body for updating an existing shipment.

merchant_invoice_idstring

ID of the invoice (must belong to one of your sub-merchants).

Example:"inv_9876543210fedcba"
shipment_tracking_numberstring

Tracking number for the shipment.

Example:"1Z987F65432109876"
shipment_courierstring

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.

Example:"fedex"
fileobject(ShipmentFile)

Proof of delivery file. Cannot be added for shipments with 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.

Example:
{
  "url": "https://bucket.s3.amazonaws.com/1234567890-document.pdf",
  "size": 204800,
  "metadata": {
    "original_filename": "proof_of_delivery.pdf"
  }
}
curl -i -X PUT \
  https://docs.resolvepay.com/_mock/partners-api/openapi/shipments/ship_1234567890abcdef \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "merchant_invoice_id": "inv_9876543210fedcba",
    "shipment_tracking_number": "1Z987F65432109876",
    "shipment_courier": "fedex",
    "file": {
      "url": "https://bucket.s3.amazonaws.com/1234567890-document.pdf",
      "size": 204800,
      "metadata": {
        "original_filename": "proof_of_delivery.pdf"
      }
    }
  }'

Responses

An object representing the Shipment.

Bodyapplication/json
idstring

Unique identifier of the Shipment.

Example:"ship_1234567890abcdef"
merchant_invoice_idstring

ID of the associated merchant invoice.

Example:"inv_1234567890abcdef"
fulfillment_methodstring

Method of fulfillment for the shipment.

Enum:"shipping_provider""self_delivery""customer_pickup""services_only"
Example:"shipping_provider"
shipment_tracking_numberstring

Tracking number provided by the shipping courier.

Example:"1Z123E45678901234"
shipment_courierstring

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.

Example:"ups"
verification_statusstring

Manual or automatic verification status of the shipment.

Enum:"verified""pending"
Example:"verified"
created_atstring, (date-time)

Date time when the shipment was created.

Example:"2024-01-15T10:30:00Z"
updated_atstring, (date-time)

Date time when the shipment was last updated.

Example:"2024-01-15T14:45:00Z"
tracking_statusstring or null

Current tracking status of the shipment from the courier.

Example:"delivered"
tracking_substatusstring or null

Detailed tracking substatus providing additional context about the shipment's current state.

Example:"delivered_001"
expected_deliverystring or null, (date-time)

Expected delivery date and time provided by the shipping courier.

Example:"2024-01-20T18:00:00Z"
Response
{
  "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"
}