Get list of orders | emnify Documentation

curl -G https://cdn.emnify.net/api/v1/shop/order \
     -H "Authorization: Bearer <token>" \
     -d q= \
     -d sort=

[
  {
    "line": [
      {
        "product": {
          "id": 2,
          "name": "4 in 1 Commercial",
          "description": "<b>Best for modern phones and devices with Nano-SIM slots:</b><br>Pre-punched SIMs:<br>- Full-size (1FF)<br>- Mini (2FF)<br>- Micro (3FF)<br>- Nano (4FF)",
          "translation_key": "4_in_1_commercial",
          "image_url": "https://portal.emnify.com/images/evaluation-pack-order-page-article-1_2_3_4_ff_4_in_1.svg",
          "info": {
            "sim_model": {
              "id": 35,
              "description": "DIM Commercial",
              "sim_manufacturer": {
                "id": 5
              },
              "sim_formfactor": {
                "id": 8
              },
              "memory_size": 64
            }
          }
        },
        "variant": [
          {
            "id": 123,
            "ean": "652827513777",
            "name": "V5 Commercial 4in1 - ½ size",
            "batch_size": 25,
            "quantity": 1,
            "price": 65,
            "iccid_range": [
              {
                "id": 1,
                "start": "8988303000006269600",
                "end": "8988303000006266024",
                "provisioned": false
              }
            ],
            "order_template": {
              "tariff_profile": {
                "id": 1
              },
              "service_profile": {
                "id": 1
              },
              "imei_lock": 1,
              "tags": "tag, tag2",
              "default_name": "Test SIM"
            },
            "item_id": 1
          }
        ],
        "total": 65
      }
    ],
    "paid": true,
    "status": {
      "id": 1,
      "description": "SUBMITTED"
    },
    "customer_organisation": {
      "id": 1,
      "name": "org1"
    },
    "customer_user": {
      "id": 1,
      "name": "user",
      "username": "user@localhost"
    },
    "shipping_option": {
      "id": 2,
      "name": "UPS Express Saver",
      "description": "1-3 Working Days, Trackable",
      "fee": 15,
      "currency": {
        "code": "EUR",
        "symbol": "€",
        "id": 1
      }
    },
    "payment_option": {
      "name": "Credit Card / PayPal",
      "id": 2,
      "type": "Braintree"
    },
    "invoice_address": {
      "name": "Customer",
      "street": "Street",
      "zipcode": "12345",
      "city": "City",
      "country": {
        "id": 74,
        "name": "Germany",
        "country_code": 49,
        "iso_code": "de"
      },
      "email": "user@localhost"
    },
    "shipping_address": {
      "organisation": {
        "name": "My org"
      },
      "name": "Customer",
      "title": "Dr.",
      "street": "Street",
      "zipcode": "12345",
      "city": "City",
      "country": {
        "id": 74,
        "name": "Germany",
        "country_code": "49",
        "iso_code": "de"
      },
      "phone": "123456789"
    },
    "currency": {
      "code": "EUR",
      "symbol": "€",
      "id": 1
    },
    "submit_date": "2021-05-26T13:54:10.000Z",
    "total": 80,
    "vat": 0,
    "vat_rate": 0,
    "meta": {
      "total_sim_count": 25
    },
    "purchase_order_number": "REF-12345",
    "id": 5,
    "external_paymet_reference": "ref"
  }
]

Returns a list of orders.

For enterprise organizations, orders where the logged-in organization is the customer will be returned. For parent organizations, orders where the logged-in organizations is the issuer or the reseller will be returned.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the POST request to /api/v1/authenticate.

Query parameters

qstringOptional

Filter parameter in <field><operator><value> format. Expects comma separated list of filtering criteria out of the following fields:

id

Supported operators:

:: equal
!:: not equal
>: greater than
>=: greater than or equal
<: less than
<=: less than or equal
^~: like
submit_date

Supported operators:
- :: equal
- >: greater than
- >=: greater than or equal
- <: less than
- <=: less than or equal
status

Possible values:
- 0: EDITING
- 1: SUBMITTED
- 2: SHIPPED
- 3: DELIVERED
- 4: CANCELED
Supported operators:
- :: equal
- !:: not equal
- >: greater than
- >=: greater than or equal
- <: less than
- <=: less than or equal
paid

Possible values:
- 0: unpaid
- 1: paid
Supported operators:
- :: equal
- !:: not equal

Filter parameter in `<field><operator><value>` format. Expects comma separated list of filtering criteria out of the following fields: - `id` Supported operators: - `:`: equal - `!:`: not equal - `>`: greater than - `>=`: greater than or equal - `<`: less than - `<=`: less than or equal - `^~`: like - `submit_date` Supported operators: - `:`: equal - `>`: greater than - `>=`: greater than or equal - `<`: less than - `<=`: less than or equal - `status` Possible values: - `0`: EDITING - `1`: SUBMITTED - `2`: SHIPPED - `3`: DELIVERED - `4`: CANCELED Supported operators: - `:`: equal - `!:`: not equal - `>`: greater than - `>=`: greater than or equal - `<`: less than - `<=`: less than or equal - `paid` Possible values: - `0`: unpaid - `1`: paid Supported operators: - `:`: equal - `!:`: not equal

sortstringOptional

Sorting parameter in <operator><field> format. Sort properties according to a comma-separated list from the allowed fields:

id
submit_date
total_amount

Supported operators:

-: descending order
+: ascending order

If no operator is supplied, ascending order will be applied.

If no sorting options are supplied, the response will be sorted by submit_date in descending order, meaning the newest order will be listed first.

Sorting parameter in `<operator><field>` format. Sort properties according to a comma-separated list from the allowed fields: - `id` - `submit_date` - `total_amount` Supported operators: - `-`: descending order - `+`: ascending order If no operator is supplied, ascending order will be applied. If no sorting options are supplied, the response will be sorted by `submit_date` in descending order, meaning the newest order will be listed first.

per_pageintegerOptional

Defines the number of items per page

pageintegerOptional

Current page number

Response headers

X-pageinteger

The current page number

X-per-pageinteger

Number of orders per page

X-pagesinteger

Total number of pages

X-countinteger

Total count of orders

Response

linelist of objects or null

paidboolean or null

statusobject or null

customer_organisationobject or null

customer_userobject or null

shipping_optionobject or null

shipped_withobject or null

payment_optionobject or null

invoice_addressobject or null

shipping_addressobject or null

currencyobject or null

submit_datestring or nullformat: "date-time"

shipped_datestring or nullformat: "date-time"

delivered_datestring or nullformat: "date-time"

external_payment_referencestring or null

external_shipping_referencestring or null

totaldouble or null

vatdouble or null

vat_ratedouble or null

metaobject or null

auto_provisioningboolean or null

purchase_order_numberstring or null

Authentication

Query parameters

Response headers

Response

Errors