API Reference

Push a shipment tracking number

post
https://api.protectplus.io/shipments
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 64
string
required
string | null
string | null
date-time | null
date-time | null
items
array of objects | null
items
servicelevel
object | null
ship_to
object | null
Headers
string
enum
Defaults to application/json
Allowed:
Responses

detail is "token expired", re-mint via
POST /auth/v1/token and retry with the new bearer.

(store, tracking_number) pair
already exists. This is the standard response for any retry of
POST /shipments after the first successful create, not just a
concurrent-write race.

The existing extension carries the existing shipment's
identifiers (shipment_id, tracking_number, carrier) so the
OMS can recover without an extra GET. Use
PATCH /shipments/{trackingNumber} to apply updates to editable
fields; tracking_number and carrier are immutable.

type values:

  • errors/tracking-not-enabled — Tracking is not enabled for
    this store. Enable tracking in your Protect+ dashboard.
  • errors/oms-push-disabled — This store is not configured for
    OMS push ingestion. Contact your Protect+ account manager.

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 1 month ago