--- title: "List shopping list orders" method: GET path: "/shoppinglistorder" tags: ["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 - `paginationStart` integer - `freetext` string - `paginationPageLength` integer - `received` integer - `notReceived` integer - `brand` string - `partner_storeid` integer, nullable - `supplierid` integer, nullable - `partnerOrderStatus` 'pending' | 'handled', nullable - `ingoing` boolean - `scopeSupplier` boolean ## Response `200` Ok - SearchShoppingListOrderResponse: The representation of a shopping list search. - `content` ShoppingListOrder[] - `id` integer: A unique ID - `orderlistno` integer: The number of orderlistno (unique for storeid) - `note` string, nullable: A note - `orderdate` string, nullable: date when ordered - `orderids` integer[], nullable, required - `receiveditems` integer: Number of shopping list items which have been received - `itemcount` integer: Total number of shopping list items on the order - `invoicesupplierid` integer, nullable: Supplier ID to invoice - `invoiceduedate` string, nullable: Set custom invoice duedate to override the normal duedate fetched from the E-conomic supplier. Format according to ISO-8601 (YYYY-MM-DD). - `invoicedate` string, nullable: Set custom invoice date to override committed date. Format according to ISO-8601 (YYYY-MM-DD). - `invoicesupplier` Supplier - `id` integer, nullable: A unique id for a supplier - `name` string: The name of a supplier - `email` string, nullable: The mail of a supplier - `customerno` string, nullable: Customer number for the supplier - `address` string, nullable: Address of the supplier - `city` string, nullable: Which city the supplier is from - `zipcode` string, nullable: Zipcode of the supplier - `note` string, nullable - `handle` string, nullable: Slug for the supplier based on the name - `accountnumber` number, nullable: Accountnumber for the supplier, used to cross reference this supplier to a supplier in e-conomic - `auto_create_orderlist` boolean, nullable: If true, an orderlist will be created automatically for this supplier - `auto_create_orderlist_frequency` 'daily' | 'weekly' | 'monthly' | 'yearly' | 'null', nullable: The frequency of the orderlist creation - `auto_create_orderlist_day_of_week` integer[], nullable: The day of the week the orderlist should be created - `auto_create_orderlist_months` integer[], nullable: The months the orderlist should be created - `auto_create_orderlist_day_of_month` integer[], nullable: The day of the month the orderlist should be created - `auto_create_orderlist_minimum_costprice` number, nullable: The minimum costprice required to trigger the automatic creation of the order list - `external_supplier` string, nullable: The external supplier used for integrations, if given (e.g. "ponbike", etc) - `external_supplier_active` boolean, nullable: Whether the external supplier integration (e.g. "ponbike"/Gazelle) is currently authorized and active. Null when the supplier has no external_supplier. - `partner_store_id` integer, nullable: OBSOLETE - The store id from the available partner store - `verified_supplier_id` integer, nullable: Id of the verified supplier this supplier is linked to - `verified_supplier` VerifiedSupplierSummary - `id` integer, required - `name` string, required - `email` string, required - `image_url` string, nullable, required - `suppliers` Supplier[], nullable - `id` integer, nullable: A unique id for a supplier - `name` string: The name of a supplier - `email` string, nullable: The mail of a supplier - `customerno` string, nullable: Customer number for the supplier - `address` string, nullable: Address of the supplier - `city` string, nullable: Which city the supplier is from - `zipcode` string, nullable: Zipcode of the supplier - `note` string, nullable - `handle` string, nullable: Slug for the supplier based on the name - `accountnumber` number, nullable: Accountnumber for the supplier, used to cross reference this supplier to a supplier in e-conomic - `auto_create_orderlist` boolean, nullable: If true, an orderlist will be created automatically for this supplier - `auto_create_orderlist_frequency` 'daily' | 'weekly' | 'monthly' | 'yearly' | 'null', nullable: The frequency of the orderlist creation - `auto_create_orderlist_day_of_week` integer[], nullable: The day of the week the orderlist should be created - `auto_create_orderlist_months` integer[], nullable: The months the orderlist should be created - `auto_create_orderlist_day_of_month` integer[], nullable: The day of the month the orderlist should be created - `auto_create_orderlist_minimum_costprice` number, nullable: The minimum costprice required to trigger the automatic creation of the order list - `external_supplier` string, nullable: The external supplier used for integrations, if given (e.g. "ponbike", etc) - `external_supplier_active` boolean, nullable: Whether the external supplier integration (e.g. "ponbike"/Gazelle) is currently authorized and active. Null when the supplier has no external_supplier. - `partner_store_id` integer, nullable: OBSOLETE - The store id from the available partner store - `verified_supplier_id` integer, nullable: Id of the verified supplier this supplier is linked to - `verified_supplier` VerifiedSupplierSummary - `id` integer, required - `name` string, required - `email` string, required - `image_url` string, nullable, required - `totalamount` integer: Total amount of items that needs to be ordered - `totalreceived` integer: Total amount of received items - `totalinorder` integer: Total amount of items that are still in order - `totalmovepending` integer, nullable: Total amount of items that are in a stocktransaction move but not committed yet. - `totalpending` integer, nullable: Total amount of items that are in a stocktransaction reception but not committed yet. - `total_sent_from_partner` integer, nullable: Total amount of items that are sent from the partner store. - `partner_order_on_shopping_list` integer, nullable: Total amount of partner order items that have been added to the shopping list. - `completed` boolean: 1 if the order is completed, 0 otherwise - `delivereddate` string, nullable: Date of latest received item if completed - `invoicenumber` string, nullable: Invoice number of the shopping list order - `shippingcost` number, nullable - `store` Store: Store object - `id` integer - `title` string, required - `cityname` string, nullable - `zipcode` string, nullable - `streetname` string, nullable - `streetno` string, nullable - `phone` string, nullable - `email` string, nullable - `website` string, nullable - `created` string - `countrydata` CountryData - `code` string: Country code in alpha2 format - `currency` string: Currency for this country - `smsprice_dkk` number: Price to send 1 sms to this country, in DKK - `smsprice_eur` number: Price to send 1 sms to this country, in EUR - `eu` boolean: true if country is member of EU - `count` integer, nullable: The total number of items found by the query. - `hasMore` boolean: True if there are data to retrieve than the given page length --- [API](https://skmtc.dev/c1st/apis/customers-1st-api.md) - [All operations](https://skmtc.dev/c1st/apis/customers-1st-api/llms.txt) - [OpenAPI document](https://skmtc.dev/c1st/apis/customers-1st-api/revisions/4250bb326f2a?raw)