/msc/shipments

POST /api/msc/shipments

Price: 1 credit

Track an MSC shipment by container or bill of lading number: route, ports of load and discharge, transshipments, ETA and every container's event timeline with terminal and vessel.

How to use it

Tracks one MSC shipment. Each container carries its own dated event timeline, highest `order` first, and `pod_eta_date` is the carrier's estimate for the discharge port.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• tracking_number string required — MSC container number or bill of lading number (examples: "MSCU1234567")
• tracking_mode string required — Whether tracking_number is a container number or a bill of lading number (one of: "container_or_bill_of_lading"; examples: "container_or_bill_of_lading")

Response

• @type string (default: "MscShipment")
• id string required
• tracking_type string nullable
• bills_of_lading array (default: [])
  • @type string (default: "MscBillOfLading")
  • bill_of_lading_number string nullable
  • container_count integer nullable
  • is_delivered boolean nullable
  • shipped_from string nullable
  • shipped_to string nullable
  • port_of_load string nullable
  • port_of_discharge string nullable
  • transshipments array (default: [])
  • price_calculation_date string nullable
  • final_pod_eta_date string nullable
  • containers array (default: [])
    • @type string (default: "MscShipmentContainer")
    • container_number string required
    • container_type string nullable
    • latest_move string nullable
    • pod_eta_date string nullable
    • is_delivered boolean nullable
    • events array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — MSC has no shipment for this number in the chosen tracking mode Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.