Skip to main content
POST
Create a receiving report

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Headers

Idempotency-Key
string

Optional opt-in idempotency token. When supplied, a retry carrying the same key replays the original stored response (with an Idempotent-Replay: true header) instead of creating a second receiving report. Reusing the same key with a different request body returns 409. Omit it to disable the guard for this request.

Body

application/json
received_date
string<date>
required
items
object[]
required
tracking_number
string
received_by
string
received_at
string<date-time>
shipped_via
string
extra_costs
object[]

Response

Successful response

id
integer
created_at
string<date-time>
updated_at
string<date-time>
status
string
received_date
string<date-time>
tracking_number
string
received_by
string
received_at
string<date-time> | null
shipped_via
string
total_quantity
number
total_tax
number
total_cost
number
shipping_cost
number
purchase_orders
object[]
items
object[]
extra_costs
object[]