Sales | Orders

List sales orders of your customers

get

Sales orders contain one or more items representing orders for new services and cancellations or changes to existing service instances (subscriptions).

This route is primarily for controlling. To fulfill these items please see fulfillment orders route.

You can only access orders of customers of your provider entity.

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters

customersinteger · int32[]Optional

Filter the orders by one or more customer ids or names.

afterstring · date-timeOptional

Filter the orders created after the specified date.

beforestring · date-timeOptional

Filter the orders created before the specified date.

sortBystringOptional

Sort the results by a given criterion (customer|date).

Default: date

sortOrderstringOptional

Sort the results in a given order (asc|desc).

Default: desc

offsetinteger · int32Optional

Specifies the index of the first result to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of results to return (min: 1; max: 1000)

Default: 100

Responses

200

OK: List of orders.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

get/v1/sales/orders

HTTPcURLJavaScriptPython

GET /v1/sales/orders HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "status": "unknown",
      "customer": {
        "id": 4,
        "name": "foo Inc.",
        "customerNumber": "C00001",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "note": "text",
      "orderedBy": {
        "id": 4,
        "firstName": "Pierce",
        "lastName": "Bell",
        "email": "[e-mail]",
        "username": "[e-mail]",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "items": {
        "total": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "id": 2324576,
      "customerOrderNumber": "RQ12345",
      "orderNumber": "4321",
      "created": "2021-06-08T11:34:30",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single sales order by its id.

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

orderIdinteger · int64Required

The identifier of the sales order.

Responses

200

OK: The requested sales order.

application/json

statusstring · enumRequired

Status of an order / order item

Possible values:

notestring · nullableOptional

Note the customer can add to their order in a html format.

idinteger · int64Required

The identifier of the order is also the order number.

Example: 2324576

customerOrderNumberstring · max: 100 · nullableOptional

Order reference number from the customer

Example: RQ12345

orderNumberstring · min: 1Required

Unique reference number of the sales order.

Example: 4321

createdstring · date-timeRequired

The date and time when the order was placed. (ISO 8601 format)

Example: 2021-06-08T11:34:30

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

get/v1/sales/orders/{orderId}

HTTPcURLJavaScriptPython

GET /v1/sales/orders/{orderId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "status": "unknown",
  "customer": {
    "id": 4,
    "name": "foo Inc.",
    "customerNumber": "C00001",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "note": "text",
  "orderedBy": {
    "id": 4,
    "firstName": "Pierce",
    "lastName": "Bell",
    "email": "[e-mail]",
    "username": "[e-mail]",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "items": {
    "total": 1,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "id": 2324576,
  "customerOrderNumber": "RQ12345",
  "orderNumber": "4321",
  "created": "2021-06-08T11:34:30",
  "self": {
    "href": "text",
    "method": "text"
  }
}