> For the complete documentation index, see [llms.txt](https://bump.sh/zim/doc/esim-api/llms.txt)

# Retrieve an Order

> GET /orders/{orderID}
> 
> Returns an Order created by the authenticated User. With `expand=true` the Order also includes its `plan`, `subscription` (with its eSIM), `notifyRecipient` and `failureReason`.



## Servers
- Production: https://zim.api.zimconnections.com (Production)
- Sandbox: https://zim.api.dev.zimconnections.com (Sandbox)


## Authentication methods
- Oauth2 & App identifier


## Parameters

### Path parameters

- **orderID** (string)
  ID of the Order


### Query parameters

- **expand** (boolean)



## Responses
### 200
Order fetched successfully

#### Body: application/json (object)
- **id** (string)
  The Order's ID

- **status** (string)
  Statuses:
    * `PENDING_APPROVAL` - The Order is awaiting approval from an Admin / Purchaser / Owner
    * `PENDING_PAYMENT` - The Order is awaiting payment
    * `PROCESSING` - The Order is being processed by the network and should soon be fulfilled
    * `FULFILLED` - The Order has been fulfilled and the associated Subscription / eSIM is ready
    * `CANCELLED` - The Order has been cancelled before being charged
    * `REFUNDED` - The Order has been cancelled and its charge reversed
    * `FAILED` - The Order has failed — see `failureReason` for details
    * `REPLACED` - The Order has been superseded by a newer one
    * `IN_BASKET` - The Order is currently sitting in the User's basket

- **accountID** (string)
  The Account ID linked to the Order

- **planID** (string)
  The Plan ID linked to the Order

- **userID** (string)
  The User ID for which the Order was generated

- **type** (string)
  Types:
    * `ONE_OFF` - The Order is a one-off purchase
    * `TOP_UP` - The Order tops up an existing Subscription
    * `RECURRING` - The Order is part of a recurring Subscription (UK domestic plans)

- **notifyRecipient** (boolean)
  If `true`, the end User has been (or will be) notified about this Order. Returned with `expand=true`.

- **failureReason** (string)
  Free-text explanation set when `status` is `FAILED`. Returned with `expand=true`.

- **plan** (object)

- **subscription** (object)

- **createdAt** (string(date-time))


### 401
Missing or invalid access token or `X-App-Identifier`

#### Body: application/json (object)
- **statusCode** (integer)

- **message** (string | array[string])
  Human-readable reason, or one entry per invalid property for validation errors

- **error** (string)


### 404
Resource not found or not owned by your Account

#### Body: application/json (object)
- **statusCode** (integer)

- **message** (string | array[string])
  Human-readable reason, or one entry per invalid property for validation errors

- **error** (string)



[Powered by Bump.sh](https://bump.sh)
