03API reference

Version 1.0.0Made from openapi.yaml

Orders

Needs a private key that carries the orders permissions. Server-to-server only.

GET/ordersList orders POST/ordersSend an order GET/orders/{id}One order GET/orders/{id}/fillWhere each line stands POST/orders/{id}/matchMatch an order to your store's order POST/orders/{id}/cancelCancel an order POST/orders/{id}/readyMark ready to ship POST/orders/{id}/shipMark shipped POST/orders/{id}/deliverFinish as delivered POST/orders/{id}/linesAdd an item to an order PATCH/orders/{id}/lines/{line_no}Change a line DELETE/orders/{id}/lines/{line_no}Remove a line

List orders

GET/orders

Scoped private key (rm_prv_), from a server

orders:read

The store's orders, oldest change first, with cursor paging. Lines are included without their fill state (read one order for that). The shopper's details are included for a key with orders:read, which every call here needs. Needs the orders:read permission.

Parameters

Name	In	Type	Description
`status`	query	`"pending" \| "open" \| "closed" \| "cancelled"`
`source`	query	`"api" \| "manual"`
`store_order_number`	query	`string`
`ref`	query	`string`	The intake_ref you sent.
`updated_since`	query	`string`	ISO 8601 date or time. Lists what changed at or after it, oldest change first.
`limit`	query	`integer`	Default 50. 1 to 100.
`cursor`	query	`string`	The `next_cursor` of the previous page. Opaque; do not build or change one. A cursor belongs to the request that produced it; with other parameters it is `bad_cursor`. Up to 2048 characters.

Responses

200A page.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object[]`
data[].`id`required	`string`
data[].`intake_ref`required	`string`
data[].`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data[].`kind`	`string \| null`
data[].`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data[].`match_state`required	`"unmatched" \| "auto" \| "manual"`
data[].`store_order_number`	`string \| null`
data[].`store_order_ref`	`string \| null`
data[].`store_cart_ref`	`string \| null`
data[].`dealer_po`	`string \| null`
data[].`pickup`	`boolean`
data[].`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data[].ffl.`id`	`string`
data[].ffl.`license_number`	`string`
data[].ffl.`name`	`string`
data[].ffl.`phone`	`string \| null`
data[].ffl.`street`	`string \| null`
data[].ffl.`city`	`string`
data[].ffl.`state`	`string`
data[].ffl.`zip`	`string`
data[].ffl.`list_as_of`	`string \| null`
data[].`cancelled_reason`	`string \| null`
data[].`ready_at`	`string (date-time) \| null`
data[].`shipped_at`	`string (date-time) \| null`
data[].`delivered_at`	`string (date-time) \| null`
data[].`tracking`	`string \| null`
data[].`totals`required	`object`
data[].totals.`currency`	`string`
data[].totals.`subtotal_cents`	`integer \| null`
data[].totals.`shipping_cents`	`integer \| null`
data[].totals.`tax_cents`	`integer \| null`
data[].totals.`total_cents`	`integer \| null`
data[].`lines`required	`object[]`
data[].lines[].`line_no`required	`integer`
data[].lines[].`sku`	`string \| null`
data[].lines[].`title`required	`string`
data[].lines[].`quantity`required	`integer`
data[].lines[].`unit_price_cents`	`integer \| null`
data[].lines[].`product_key`	`string \| null`
data[].lines[].`ships_to`required	`"ffl" \| "customer"`
data[].lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data[].lines[].`flagged`	`string \| null`
data[].lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data[].lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data[].lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data[].lines[].`editable`	`boolean`	Only on a single order.
data[].lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data[].`shopper`	`object \| null`	Only for a key with `orders:read`.
data[].shopper.`name`	`string \| null`
data[].shopper.`email`	`string \| null`
data[].shopper.`phone`	`string \| null`
data[].`billing`	`object \| null`	Only for a key with `orders:read`.
data[].`shipping`	`object \| null`	Only for a key with `orders:read`.
data[].`received_at`required	`string (date-time)`
data[].`updated_at`required	`string (date-time)`
`next_cursor`required	`string \| null`

Errors400401403429503in the error envelope.

Example

Shell
curl "https://app.getrollmark.com/api/v1/orders" \
  -H "Authorization: Bearer $ROLLMARK_KEY"

Send an order

POST/orders

Scoped private key (rm_prv_), from a server

orders:write

Sends an order with the intake contract of the FFL Checkout API (checkout-api.md, section 3): pending until matched, or open and matched at once when it carries store_order_number. Idempotent on intake_ref, and on Idempotency-Key. The answer has the shopper's details only if the key also has orders:read. At most 256 KB; no card data, ever. Needs the orders:write permission.

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	`string`	1 to 255 printable characters (a UUID is fine). The first request with a key runs and its answer is kept for 24 hours; the same request again gets the same answer with `Idempotent-Replay: true`. The same key with a different method, path or body is `409 idempotency_conflict`. A refusal is not kept, so a corrected request can use the same key. 1 to 255 characters.

Request body

Field	Type	Description
`intake_ref`required	`string`	Your key for the order (a cart id). Makes the call idempotent. Up to 100 characters.
`store_cart_ref`	`string`	Up to 60 characters.
`store_order_number`	`string \| null`	When given Up to 40 characters.
`store_order_ref`	`string \| null`	Up to 60 characters.
`dealer_po`	`string \| null`	Up to 25 characters.
`shopper`required	`object`
shopper.`name`required	`string`
shopper.`email`required	`string (email)`
shopper.`phone`	`string`
`billing`required	`object`
billing.`name`	`string`
billing.`line1`required	`string`
billing.`line2`	`string`
billing.`city`required	`string`
billing.`state`required	`string`
billing.`zip`required	`string`
billing.`country`required	`string`
`shipping`	`object`
shipping.`name`	`string`
shipping.`line1`required	`string`
shipping.`line2`	`string`
shipping.`city`required	`string`
shipping.`state`required	`string`
shipping.`zip`required	`string`
shipping.`country`required	`string`
`ffl`	`object`	Required when any line ships to the FFL. `id` or `license_number`, any formatting.
ffl.`id`	`string`
ffl.`license_number`	`string`
`lines`required	`object[]`	1 to 200 items.
lines[].`sku`	`string`
lines[].`upc`	`string`	Pattern `^[0-9]{8,14}$`.
lines[].`mpn`	`string`
lines[].`manufacturer`	`string`
lines[].`title`required	`string`
lines[].`quantity`required	`integer`	1 to 10000.
lines[].`unit_price_cents`	`integer`	At least 0.
lines[].`needs_ffl`	`boolean`	A hint. The library decides; a disagreement is flagged `store_disagrees`.
`totals`	`object`
totals.`currency`	`string`	3 to 3 characters.
totals.`subtotal_cents`	`integer`
totals.`shipping_cents`	`integer`
totals.`tax_cents`	`integer`
totals.`total_cents`	`integer`

Responses

200The same order again (a replay of the intake_ref or of the Idempotency-Key).

Headers: Idempotent-Replay

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`

201Created.

Errors400401403409413422429503in the error envelope.

Example

Shell
curl -X POST "https://app.getrollmark.com/api/v1/orders" \
  -H "Authorization: Bearer $ROLLMARK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"intake_ref":"…","shopper":{"name":"…","email":"[email protected]"},"billing":{"line1":"…","city":"…","state":"…","zip":"…","country":"…"},"lines":[{"title":"…","quantity":1}]}'

One order

GET/orders/{id}

Scoped private key (rm_prv_), from a server

orders:read

The order with its lines, where each line stands and whether it can still be changed. Needs the orders:read permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.

Responses

200The order.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`

Errors401403404429503in the error envelope.

Example

Shell
curl "https://app.getrollmark.com/api/v1/orders/<id>" \
  -H "Authorization: Bearer $ROLLMARK_KEY"

Where each line stands

GET/orders/{id}/fill

Scoped private key (rm_prv_), from a server

orders:read

For each line: not ordered, partly ordered, on a PO, ordered, shipped, at the shop or delivered, with the distributor orders behind it. Needs the orders:read permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.

Responses

200The fill state.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`order_id`required	`string`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`quantity`required	`integer`
data.lines[].`state`required	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered"`
data.lines[].`covered`required	`integer`
data.lines[].`distributor_orders`required	`object[]`
data.lines[].distributor_orders[].`id`	`string`
data.lines[].distributor_orders[].`po_number`	`string`
data.lines[].distributor_orders[].`distributor`	`string`
data.lines[].distributor_orders[].`status`	`string`
data.lines[].distributor_orders[].`quantity`	`integer`
data.lines[].distributor_orders[].`shipped_quantity`	`integer`
data.lines[].distributor_orders[].`received_quantity`	`integer`

Errors401403404429503in the error envelope.

Example

Shell
curl "https://app.getrollmark.com/api/v1/orders/<id>/fill" \
  -H "Authorization: Bearer $ROLLMARK_KEY"

Match an order to your store's order

POST/orders/{id}/match

Scoped private key (rm_prv_), from a server

orders:write

{ store_order_number, store_order_ref? }. Makes a pending order open. The same number again is 200; another number is 409 already_matched; an order staff cancelled is 409 order_cancelled; a number another order has is 409 store_order_number_in_use. Needs the orders:write permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.
`Idempotency-Key`	header	`string`	1 to 255 printable characters (a UUID is fine). The first request with a key runs and its answer is kept for 24 hours; the same request again gets the same answer with `Idempotent-Replay: true`. The same key with a different method, path or body is `409 idempotency_conflict`. A refusal is not kept, so a corrected request can use the same key. 1 to 255 characters.

Request body

Field	Type	Description
`store_order_number`required	`string`	Up to 40 characters.
`store_order_ref`	`string`	Up to 60 characters.

Responses

200The order.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`

Errors400401403404409429503in the error envelope.

Example

Shell
curl -X POST "https://app.getrollmark.com/api/v1/orders/<id>/match" \
  -H "Authorization: Bearer $ROLLMARK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"store_order_number":"…"}'

Cancel an order

POST/orders/{id}/cancel

Scoped private key (rm_prv_), from a server

orders:write

{ reason }, 3 to 300 characters; the store can read it. A closed order is 409 order_closed; one already cancelled is 409 order_cancelled. An order that had shipped keeps its shipment on record. Needs the orders:write permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.
`Idempotency-Key`	header	`string`	1 to 255 printable characters (a UUID is fine). The first request with a key runs and its answer is kept for 24 hours; the same request again gets the same answer with `Idempotent-Replay: true`. The same key with a different method, path or body is `409 idempotency_conflict`. A refusal is not kept, so a corrected request can use the same key. 1 to 255 characters.

Request body

Field	Type	Description
`reason`required	`string`	3 to 300 characters.

Responses

200The order.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`

Errors400401403404409429503in the error envelope.

Example

Shell
curl -X POST "https://app.getrollmark.com/api/v1/orders/<id>/cancel" \
  -H "Authorization: Bearer $ROLLMARK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"…"}'

Mark ready to ship

POST/orders/{id}/ready

Scoped private key (rm_prv_), from a server

orders:write

Only an open order that ships to an FFL (a transfer). An order with no FFL is 409 not_a_transfer. Needs the orders:write permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.
`Idempotency-Key`	header	`string`	1 to 255 printable characters (a UUID is fine). The first request with a key runs and its answer is kept for 24 hours; the same request again gets the same answer with `Idempotent-Replay: true`. The same key with a different method, path or body is `409 idempotency_conflict`. A refusal is not kept, so a corrected request can use the same key. 1 to 255 characters.

Responses

200The order.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`

Errors401403404409429503in the error envelope.

Example

Shell
curl -X POST "https://app.getrollmark.com/api/v1/orders/<id>/ready" \
  -H "Authorization: Bearer $ROLLMARK_KEY"

Mark shipped

POST/orders/{id}/ship

Scoped private key (rm_prv_), from a server

orders:write

Idempotency-Key required

{ tracking? }. Sets shipped_at once and never clears it. A shipment marked shipped counts toward Rollmark Transfers billing, so an Idempotency-Key is required. Shipping again with the same tracking is 200; with another it is 409 already_shipped. Only an open order that ships to an FFL. Needs the orders:write permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.
`Idempotency-Key`required	header	`string`	Required on this call, because it counts toward billing. See the other calls for how the key works. 1 to 255 characters.

Request body (optional)

Field	Type	Description
`tracking`	`string`	Up to 120 characters.

Responses

200The order.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`

Errors400401403404409429503in the error envelope.

Example

Shell
curl -X POST "https://app.getrollmark.com/api/v1/orders/<id>/ship" \
  -H "Authorization: Bearer $ROLLMARK_KEY" \
  -H "Idempotency-Key: <one id per action>" \
  -H "Content-Type: application/json" \
  -d '{}'

Finish as delivered

POST/orders/{id}/deliver

Scoped private key (rm_prv_), from a server

orders:write

After it shipped. The order is then closed. Needs the orders:write permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.
`Idempotency-Key`	header	`string`	1 to 255 printable characters (a UUID is fine). The first request with a key runs and its answer is kept for 24 hours; the same request again gets the same answer with `Idempotent-Replay: true`. The same key with a different method, path or body is `409 idempotency_conflict`. A refusal is not kept, so a corrected request can use the same key. 1 to 255 characters.

Responses

200The order.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`

Errors401403404409429503in the error envelope.

Example

Shell
curl -X POST "https://app.getrollmark.com/api/v1/orders/<id>/deliver" \
  -H "Authorization: Bearer $ROLLMARK_KEY"

Add an item to an order

POST/orders/{id}/lines

Scoped private key (rm_prv_), from a server

orders:write

{ product_key, quantity, unit_price_cents? }: an item of the store's catalog, routed (to the FFL or the customer) by the product library. A pending or open order only. The price is the store's price unless given. Needs the orders:write permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.
`Idempotency-Key`	header	`string`	1 to 255 printable characters (a UUID is fine). The first request with a key runs and its answer is kept for 24 hours; the same request again gets the same answer with `Idempotent-Replay: true`. The same key with a different method, path or body is `409 idempotency_conflict`. A refusal is not kept, so a corrected request can use the same key. 1 to 255 characters.

Request body

Field	Type	Description
`product_key`required	`string`
`quantity`required	`integer`	1 to 10000.
`unit_price_cents`	`integer \| null`	At least 0.

Responses

201The order, with added_line_no.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`
data.`added_line_no`required	`integer`
data.`warning`	`string \| null`

Errors400401403404409429503in the error envelope.

Example

Shell
curl -X POST "https://app.getrollmark.com/api/v1/orders/<id>/lines" \
  -H "Authorization: Bearer $ROLLMARK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product_key":"…","quantity":1}'

Change a line

PATCH/orders/{id}/lines/{line_no}

Scoped private key (rm_prv_), from a server

orders:write

{ quantity?, unit_price_cents? }. A line that is on a distributor order that was sent, is ready, failed, or filled from the shelf is 409 line_locked, with the reason; a cancelled or closed order is 409 order_cancelled or order_closed. Needs the orders:write permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.
`line_no`required	path	`integer`	At least 1.
`Idempotency-Key`	header	`string`	1 to 255 printable characters (a UUID is fine). The first request with a key runs and its answer is kept for 24 hours; the same request again gets the same answer with `Idempotent-Replay: true`. The same key with a different method, path or body is `409 idempotency_conflict`. A refusal is not kept, so a corrected request can use the same key. 1 to 255 characters.

Request body

Field	Type	Description
`quantity`	`integer`	1 to 10000.
`unit_price_cents`	`integer \| null`	At least 0.

Responses

200The order.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`

Errors400401403404409429503in the error envelope.

Example

Shell
curl -X PATCH "https://app.getrollmark.com/api/v1/orders/<id>/lines/<line_no>" \
  -H "Authorization: Bearer $ROLLMARK_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Remove a line

DELETE/orders/{id}/lines/{line_no}

Scoped private key (rm_prv_), from a server

orders:write

The same lock rule as changing it. The last line of an order cannot be removed (cancel the order). Needs the orders:write permission.

Parameters

Name	In	Type	Description
`id`required	path	`string`	The order id, `ref:<intake_ref>` or `store:<store_order_number>`.
`line_no`required	path	`integer`	At least 1.
`Idempotency-Key`	header	`string`	1 to 255 printable characters (a UUID is fine). The first request with a key runs and its answer is kept for 24 hours; the same request again gets the same answer with `Idempotent-Replay: true`. The same key with a different method, path or body is `409 idempotency_conflict`. A refusal is not kept, so a corrected request can use the same key. 1 to 255 characters.

Responses

200The order.

Headers: X-Request-Id, X-RateLimit-Remaining

Field	Type	Description
`data`required	`object`
data.`id`required	`string`
data.`intake_ref`required	`string`
data.`source`required	`"api" \| "manual"`	`api` for an order a store sent, `manual` for one entered by hand in Rollmark.
data.`kind`	`string \| null`
data.`status`required	`"pending" \| "open" \| "closed" \| "cancelled"`
data.`match_state`required	`"unmatched" \| "auto" \| "manual"`
data.`store_order_number`	`string \| null`
data.`store_order_ref`	`string \| null`
data.`store_cart_ref`	`string \| null`
data.`dealer_po`	`string \| null`
data.`pickup`	`boolean`
data.`ffl`	`object \| null`	The FFL as it was when the shopper chose it.
data.ffl.`id`	`string`
data.ffl.`license_number`	`string`
data.ffl.`name`	`string`
data.ffl.`phone`	`string \| null`
data.ffl.`street`	`string \| null`
data.ffl.`city`	`string`
data.ffl.`state`	`string`
data.ffl.`zip`	`string`
data.ffl.`list_as_of`	`string \| null`
data.`cancelled_reason`	`string \| null`
data.`ready_at`	`string (date-time) \| null`
data.`shipped_at`	`string (date-time) \| null`
data.`delivered_at`	`string (date-time) \| null`
data.`tracking`	`string \| null`
data.`totals`required	`object`
data.totals.`currency`	`string`
data.totals.`subtotal_cents`	`integer \| null`
data.totals.`shipping_cents`	`integer \| null`
data.totals.`tax_cents`	`integer \| null`
data.totals.`total_cents`	`integer \| null`
data.`lines`required	`object[]`
data.lines[].`line_no`required	`integer`
data.lines[].`sku`	`string \| null`
data.lines[].`title`required	`string`
data.lines[].`quantity`required	`integer`
data.lines[].`unit_price_cents`	`integer \| null`
data.lines[].`product_key`	`string \| null`
data.lines[].`ships_to`required	`"ffl" \| "customer"`
data.lines[].`ship_reason`required	`"firearm" \| "receiver" \| "library_not_firearm" \| "store_hint" \| "staff_override"`
data.lines[].`flagged`	`string \| null`
data.lines[].`fill`	`"shelf" \| "dropship" \| null`	Filled from the shelf or by drop-ship; null when not decided.
data.lines[].`added_by_staff`	`boolean`	True for a line added after the order arrived.
data.lines[].`fill_state`	`"from_shelf" \| "not_ordered" \| "partly_ordered" \| "on_po" \| "ordered" \| "shipped" \| "at_shop" \| "delivered" \| null`	Only on a single order. Where the line stands with the distributors.
data.lines[].`editable`	`boolean`	Only on a single order.
data.lines[].`locked_reason`	`string \| null`	Only on a single order. Why the line cannot be changed.
data.`shopper`	`object \| null`	Only for a key with `orders:read`.
data.shopper.`name`	`string \| null`
data.shopper.`email`	`string \| null`
data.shopper.`phone`	`string \| null`
data.`billing`	`object \| null`	Only for a key with `orders:read`.
data.`shipping`	`object \| null`	Only for a key with `orders:read`.
data.`received_at`required	`string (date-time)`
data.`updated_at`required	`string (date-time)`

Errors401403404409429503in the error envelope.

Example

Shell
curl -X DELETE "https://app.getrollmark.com/api/v1/orders/<id>/lines/<line_no>" \
  -H "Authorization: Bearer $ROLLMARK_KEY"