Sync Shipment Tracking

Request

Synchronizes shipment tracking information by fetching real-time data from the courier using the existing tracking number. This endpoint retrieves the latest tracking updates directly from the shipping provider and performs instant verification of the shipment status, ensuring that the shipment data is current and accurate.

Security

bearerAuth or basicAuth

Path

shipment_idstringrequired

ID of the Shipment to sync tracking for

Example:ship_1234567890abcdef

curl -i -X POST \
  https://docs.resolvepay.com/_mock/partners-api/openapi/shipments/ship_1234567890abcdef/sync \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

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"
}