1N1nce
Orders

Get All Orders

Get a complete list of all 1NCE orders for the given account.

get/v1/orders

Request

  • Base URL
    https://api.1nce.com/management-api
  • Auth
    HTTP bearer

Query parameters

pageinteger

Number index of the requested order list page. Use this parameter to iterate through all orders on the different pages. The total amount of pages is listed in the response header.

pageSizeinteger

Defines the size of a page, the number of individual orders listed on one page. The maximum allowed value is 10.

sortstring
Example:order_status,order_date

Sort the order list by specific keys (order_number, order_status and/or order_date) in a comma seperated list. The default is order_number if no paramter is given.

Response

OK

order_numbernumber

Order Number, a unique numerical identifier for a order.

order_type'FIRST_ORDER' | 'ADDITIONAL_ORDER' | 'TOPUP' | 'BULK_TOPUP' | 'TARIFF_CHANGE'

The order type indicates whether this is a first order, additional order or a topup.

order_datestring date-time

Date when the order was placed.

order_statusstring

Current status of the ordering process.

invoice_numberstring

Invoice Number, a unique alphanumerical identifier for the corresponding order invoice.

invoice_amountstring

The gross value which this order amounts to, as printed on the invoice.

currencystring

ISO 4217 currency code used for the invoice amount.

Example response

[
  {
    "order_number": 2000000001,
    "order_type": "FIRST_ORDER",
    "order_status": "COMPLETED",
    "invoice_number": "20000002",
    "invoice_amount": "19.99",
    "currency": "EUR",
    "shipping_address": {
      "country": "DE"
    },
    "sims": [
      {
        "iccid": "8988280666000000000",
        "_links": [
          {
            "rel": "self",
            "href": "https://api.1nce.com/api/v1/sims/9999999999000000001"
          }
        ]
      }
    ],
    "products": [
      {
        "product_id": 1001,
        "quantity": 1
      }
    ]
  }
]

Changes

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