C1c1st
ShoppingListOrders

List shopping list orders

get/shoppinglistorder

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/shoppinglistorder
  • Auth
    HTTP bearer

Query parameters

paginationStartinteger

Determine the offset (in number of items) to fetch. This is usually a multiple of the pageLength.

freetextstring

Freetext search for note, orderlist number, product title etc.

paginationPageLengthinteger

Determine the number of items to fetch in one page.

receivedinteger

If it is set to 1, it only retrieves orders with all items received

notReceivedinteger

If it is set to 1, it only retrieves orders where the items are not received

brandstring

Filter by product brand (exact match)

partner_storeidinteger nullable

Filter by the partner store that placed the order

supplieridinteger nullable

Filter by supplier

partnerOrderStatus'pending' | 'handled' nullable

Filter by partner order status

ingoingboolean

Filter to ingoing partner orders

scopeSupplierboolean

Scope query to the stores this store supplies

Response

Ok

countinteger nullable

The total number of items found by the query.

hasMoreboolean

True if there are data to retrieve than the given page length

Example response

{
  "content": [
    {
      "invoicesupplier": {
        "id": 1,
        "name": "Johnson",
        "email": "johnson@doe.com",
        "address": "A place",
        "city": "London",
        "note": "Sells bike parts"
      },
      "suppliers": [
        {
          "id": 1,
          "name": "Johnson",
          "email": "johnson@doe.com",
          "address": "A place",
          "city": "London",
          "note": "Sells bike parts"
        }
      ],
      "store": {
        "countrydata": {
          "code": "DK",
          "currency": "DKK",
          "smsprice_dkk": 0.48,
          "smsprice_eur": 0.06
        }
      }
    }
  ]
}

Changes

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