Sign in
customer

Changed on

Viewset that supports all normal viewset functionality.

get/api/customer/customer/

Request

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

Query parameters

citystring
contactstring
namestring
num_ordersstring
orderingstring[]

Fields to sort by, in order of precedence. Prefix a field with - for descending.

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.

remarksstring
sort_dirstring

Sort direction; anything but desc sorts ascending.

sort_fieldstring

The column to sort by. Sortable columns: name, city, num_orders, remarks, customer_id.

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

  • e15b768e8dcaRevision changes
    • warning

      for the query request parameter page_size, the max was set to 1000.00

    • warning

      for the query request parameter page_size, the min was set to 1.00

  • 53ac8159b552Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status