Skip to main content
POST
Mark an order shipped

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Replo-Api-Version
enum<string>
required

The public API version to use for this request.

Available options:
2026-11-17

Path Parameters

orderId
string<uuid>
required

ID of the order whose packages to list.

Body

application/json
trackingNumber
string | null

The carrier's tracking number.

Required string length: 1 - 255
trackingCarrier
string | null

The carrier, e.g. "USPS", "UPS", "FedEx" or "DHL".

Required string length: 1 - 255
trackingUrl
string<uri> | null

A tracking page. Leave it out and Replo links the carrier's own page when it knows the carrier.

Maximum string length: 2048
items
object[] | null

Items in this package. Omit for everything the merchant has not shipped yet.

Required array length: 1 - 250 elements
notifyBuyer
boolean

Whether Replo emails the buyer that the order shipped. Defaults to true. When the store's Replo Shipping account tracks the package, the email waits for the carrier's first scan (at most 24 hours); otherwise it goes out right away. False never emails the buyer about this package.

Response

Mark an order shipped

object
enum<string>
required
Available options:
fulfillment
id
string<uuid>
required
orderId
string<uuid>
required
status
enum<string>
required

BedrockFulfillmentStatus

Available options:
pending,
open,
success,
cancelled,
error,
failure
source
enum<string> | null
required

The tool that recorded the package; null for packages recorded before sources were tracked.

Available options:
reploLabel,
manual,
shipstation,
csv,
api,
printful,
null
trackingCarrier
string | null
required
trackingNumber
string | null
required
trackingUrl
string | null
required
shipmentStatus
enum<string> | null
required

Where the package is from the carrier's scans; null when no carrier scan is tracked.

Available options:
labelPurchased,
confirmed,
inTransit,
outForDelivery,
attemptedDelivery,
availableForPickup,
delivered,
returnToSender,
failure,
null
estimatedDeliveryAt
string | null
required
shippedAt
string | null
required
deliveredAt
string | null
required
items
object[]
required
createdAt
string
required
updatedAt
string
required