Update Shipment

{ "id": 123, "created_at": "<string>", "type": "shipment", "carrier": "<string>", "tracking_number": "<string>", "origin_address": { "address1": "<string>", "city": "<string>", "province": "<string>", "zip": "<string>", "country": "<string>", "address2": "<string>" }, "destination_address": { "address1": "<string>", "city": "<string>", "province": "<string>", "zip": "<string>", "country": "<string>", "address2": "<string>" }, "shipped_at": "<string>", "delivered_at": "<string>", "return_group_id": 123, "return_ids": [ 123 ] }

Headers

x-frate-api-token

string | null

Path Parameters

shipment_id

integer

required

Body

application/json

Shipment Update Input

status

enum<string>

required

The status to update the shipment to

Available options:

DRAFT,

CREATED,

IN_TRANSIT,

DELIVERED,

FAILED,

CANCELED,

UNKNOWN

Response

Successful Response

Shipment

integer

required

Unique identifier for the shipment

status

enum<string>

required

Current status of the shipment

Available options:

DRAFT,

CREATED,

IN_TRANSIT,

DELIVERED,

FAILED,

CANCELED,

UNKNOWN

created_at

string

required

ISO 8601 timestamp when the shipment was created

type

string

default:shipment

The type identifier for this resource

Allowed value: "shipment"

carrier

string | null

The shipping carrier (e.g., 'USPS', 'FedEx', 'UPS')

tracking_number

string | null

The tracking number for the shipment

origin_address

Address · object | null

The origin address for the shipment

Show child attributes

destination_address

Address · object | null

The destination address for the shipment

Show child attributes

shipped_at

string | null

ISO 8601 timestamp when the shipment was shipped

delivered_at

string | null

ISO 8601 timestamp when the shipment was delivered

return_group_id

integer | null

The ID of the return group for the shipment

return_ids

integer[]

The IDs of the returns for the shipment

Overview

Endpoints

Headers

Path Parameters

Body

Response