Skip to content

Update a shipment

PATCH
/products/{productId}/shipments/{shipmentId}
curl --request PATCH \
--url https://api.motenya.app/v1/products/example/shipments/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "carrierCode": "example", "carrierName": "example", "trackingNumber": "example", "state": "pending", "deliveredAt": "2026-11-21T09:30:00Z" }'

Requires crm:write.

productId
required
string
>= 1 characters <= 64 characters
shipmentId
required
string
>= 1 characters <= 64 characters
Media typeapplication/json
object
carrierCode
string | null
<= 40 characters
carrierName
string | null
<= 100 characters
trackingNumber
string | null
<= 100 characters
state
string | null
Allowed values: pending in_transit delivered returned canceled
deliveredAt

ISO-8601 date-time, e.g. 2026-11-21T09:30:00Z.

string | null
<= 40 characters

Example

2026-11-21T09:30:00Z

Success

Media typeapplication/json
object
id
required
string
>= 1 characters <= 64 characters
storeId
required

Null only for a subscription’s invoice.

string | null
>= 1 characters <= 64 characters
storeName
required
string | null
number
required
string
contact
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
client
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
subscription
required
object
id
required
string
>= 1 characters <= 64 characters
planName
required
string
periodStart
required
string | null
periodEnd
required
string | null
status
required
string
Allowed values: pending processing on_hold shipped completed canceled refunded
statusRaw
required
string | null
paymentStatus
required
string | null
Allowed values: unpaid partially_paid paid refunded void
paidAt
required
string | null
dueAt
required
string | null
overdue
required
boolean
currency
required
string
subtotal
required
string | null
shipping
required
string | null
tax
required
string | null
discount
required
string | null
total
required
string
paymentMethod
required
string | null
billingAddress
required
object
label
required
string | null
line1
required
string
line2
required
string | null
city
required
string
region
required
string | null
postalCode
required
string | null
country
required
string
shippingAddress
required
object
label
required
string | null
line1
required
string
line2
required
string | null
city
required
string
region
required
string | null
postalCode
required
string | null
country
required
string
placedAt
required
string
items
required
Array<object>
object
catalogItemId
required
string | null
>= 1 characters <= 64 characters
sku
required
string | null
name
required
string
quantity
required
number
unitPrice
required
string
rowTotal
required
string
options
required
Array<object>
object
label
required
string
value
required
string
shipments
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
carrierCode
required
string | null
carrierName
required
string | null
trackingNumber
required
string | null
state
required
string
Allowed values: pending in_transit delivered returned canceled
deliveredAt
required
string | null
key
additional properties
documents
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
kind
required
string
Allowed values: invoice credit_memo
number
required
string | null
amount
required
string
reason
required
string | null
issuedAt
required
string
key
additional properties
custom
required
object
key
additional properties
source
required
string
externalId
required
string | null
createdAt
required
string
updatedAt
required
string
key
additional properties

Example

{
"status": "pending",
"paymentStatus": "unpaid",
"shipments": [
{
"state": "pending"
}
],
"documents": [
{
"kind": "invoice"
}
]
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing, invalid, revoked or expired API key

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing scope, API turned off, published article without publish scope, or account suspended

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Not found, or outside the knowledge bases this key may use

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Slug or translation already exists

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rejected by validation (e.g. unknown language or category)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rate limited; see Retry-After

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Internal error