Sign in
order

Changed on

PDF generation methods for :class:OrderViewset.

get/api/order/order/order_availability/

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

assigned_countstring
integer
OR
string

One id, or several comma-separated ids. A single id may ride as a number (?customer=12); more than one, and an id list restored from a shared address, is the comma-joined string, where a comma inside an item is escaped ,.

customer_referencestring
integer
OR
string

One id, or several comma-separated ids. A single id may ride as a number (?customer=12); more than one, and an id list restored from a shared address, is the comma-joined string, where a comma inside an item is escaped ,.

end_datestring
end_date__fromstring
end_date__untilstring
external_identifierstring
last_statusstring
limitinteger

Number of results to return per page, counting from offset. Supplying this switches the endpoint from page-number to limit/offset pagination. Capped at 1000.

offsetinteger

The initial index from which to return the results. Only read when limit is supplied.

order_addressstring
order_citystring
order_idstring
order_namestring
order_referencestring
order_typestring
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page. Capped at 1000: a larger value is clamped, not rejected.

qstring

A search term.

start_datestring
start_date__fromstring
start_date__untilstring

Response

countinteger
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

  • 38f2a2316b20Revision changes
    • info

      query request parameter branch list-of-types was widened by adding types integer

    • info

      query request parameter customer_relation list-of-types was widened by adding types integer

    • info

      for the query request parameter branch, the type was generalized from string to no type

    • info

      for the query request parameter customer_relation, the type was generalized from string to no type

  • ae12f9ff8f5cRevision changes
    • info

      added the new optional query request parameter customer_relation

    • info

      for the query request parameter branch, the type was generalized from integer to string