API Reference
  1. Xegora Integration API
  2. Orders

Read how many reveals an order has left

get
https://myapi.xegora.com/api/v1/orders//fulfillment/allowance

How many more times the order's codes can be revealed — the same allowance the dashboard shows — read without revealing or counting anything. Not revealable while the order is not fulfilled or has no codes to show; remainingReveals is then 0 and revealCount says how often the codes were shown while they could be. Requires the orders.read scope; another workspace's order is 404. Sent with Cache-Control: no-store, private.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Headers
string
length ≤ 128
^[A-Za-z0-9._:-]{1,128}$

Your own correlation id, carried through Xegora's logs and audit records and returned in correlationId. Kept when it is 1–128 characters of ASCII letters, digits, ., _, : and -; anything else is replaced by an id of Xegora's.

string
enum

The language an error's message, title and detail are written in; without it, Accept-Language decides, then English. Successful responses are not translated.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 18 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 18 days ago

Did this page help you?