Orders and refunds

Poll an order (async job status)

The status endpoint for a human-fulfilled purchase — the poll half of this store's async job pattern. Free, unauthenticated, and the order id from the purchase response is the only thing needed. status is one of queued or completed; completed is terminal and carries the deliverable. Past its promised window the order grows a window_breached block stating what is owed, computed from its own timestamps. Poll no faster than once a minute.

get/api/order/{order_id}

Request

  • Base URL: https://scvd.store
  • URL: https://scvd.store/api/order/{order_id}
  • Auth: none required

Path parameters

order_idstring required

From the purchase response's order_id, or the order_url it hands you whole.

Response

The order's current state. Terminal statuses carry the deliverable.

order_idstring required
item_idstring required
item_namestring
status'queued' | 'completed' required

The job's state. Enumerated from the same array the code assigns from, so this cannot name a state that never happens.

created_atstring date-time required
completed_atstring date-time
webhookstring

The recorded callback outcome, also available as callback.result.

sla_hoursnumber

The window the keeper promised, in hours from created_at.

deliverableunknown
patron_numberinteger
badge_urlstring uri
window_breachedobject

Present only past the promised window. States what is owed and that the keeper pays it by hand.

Changes

No recorded changes to this operation across all 1 revision of this API.