Send an order to Ship (repeat to update it)

post

https://api.montavire.com/api/v1/ship/orders

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

An order to ship, from the caller's own system.

channel_name

string

length between 0 and 100

Where the sale was made, shown in Ship. Defaults to API.

currency

string

^[A-Za-z]{3}$

external_order_id

string

required

length between 0 and 100

Your id for the order; unique within your account.

lines

array of objects

required

length between 0 and 500

lines*

ordered_at

date-time

recipient

object

required

reference

string

length between 0 and 100

The order number your customer sees.

shipping_deadline

date-time

shipping_method

string

length between 0 and 100

shipping_method_code

string

length between 0 and 100

state

string

enum

OPEN (default) or CANCELLED.

Allowed:

total_price

number

≥ 0

Headers

Idempotency-Key

string

Optional client-generated key (recommended: a UUID) that makes a write safe to retry. Replaying the same key within the retention window returns the original response instead of creating a duplicate. Scoped per tenant.

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK