plentymarkets_list_orders
List orders
List orders (sales orders, returns, credit notes ...) with filters. Newest first with sort_by createdAt and sort_order desc. Returns {page, totalsCount, isLastPage, entries[]}; each entry has the id, typeId (1 = sales order), statusId, plentyId, createdAt, amounts and the order items unless add_order_items is false. GET /rest/orders.
Parameterspagewithpaid_tosort_byorder_idspaid_fromstatus_tocontact_idcreated_toorder_typesort_orderupdated_to+9 more
plentymarkets_get_order
Get an order
Get one order by id: status, amounts, dates, properties, order items, address relations. Add related data with `with` (addresses, comments, payments, documents, shippingPackages ...). GET /rest/orders/{orderId}.
Parameterswithorder_idrequiredadd_order_items
plentymarkets_get_order_status_history
Get an order's status history
The status changes of an order: which status, when, and by which user. GET /rest/orders/{orderId}/status-history.
Parametersorder_idrequired
plentymarkets_list_order_statuses
List order statuses
The order statuses defined in the system (id and name per language), to translate a statusId. Optionally a range of status ids. GET /rest/orders/statuses.
Parameterspagelanguagestatus_id_toitems_per_pagestatus_id_from
plentymarkets_list_order_referrers
List order referrers
The order referrers (sales channels: shop, eBay, Amazon, ...) with their ids, for the referrer_id filter of plentymarkets_list_orders. GET /rest/orders/referrers.
Takes no parameters.
plentymarkets_list_items
List items
List items (the product containers) with filters. Prices, stock, barcodes and SKUs belong to the variations: use plentymarkets_list_variations for those. Returns {page, totalsCount, isLastPage, entries[]}. GET /rest/items.
Parametersidlangnamepagewithupdated_toupdated_fromitems_per_pagemanufacturer_id
plentymarkets_get_item
Get an item
Get one item by id: flags, manufacturer, texts, condition, age rating and the item-level settings. GET /rest/items/{itemId}.
Parameterslangitem_idrequired
plentymarkets_list_variations
List variations
Search variations (the sellable products: number, SKU, barcodes, prices, stock, categories). Filter by item, number, barcode, SKU, active flag, category, warehouse. Use `with` for the related data (variationSalesPrices, variationBarcodes, stock, variationCategories, images ...). GET /rest/items/variations.
Parametersidskulangpagewithbarcodeis_mainitem_idis_activeitem_nameupdated_tocategory_id+7 more
plentymarkets_list_categories
List categories
List item categories (the category tree: id, parent, level, type, names with `with` details). GET /rest/categories.
Parameterslangnamepagetypewithlevelparent_iditems_per_page
plentymarkets_list_manufacturers
List manufacturers
List the manufacturers (brands) of the items: id, name, address data. GET /rest/items/manufacturers.
Parametersnamepageitems_per_page
plentymarkets_list_sales_prices
List sales price configurations
List the sales price configurations (price types such as retail or purchase price: id, type, names, which stores, countries and currencies they apply to). The prices of a variation: plentymarkets_list_variations with variationSalesPrices. GET /rest/items/sales_prices.
Parameterspageitems_per_page
plentymarkets_list_stock
List stock
List physical stock per variation and warehouse (physical stock, net stock, reserved, reorder level), optionally for one variation or changed since a date. Returns {page, totalsCount, isLastPage, entries[]}. GET /rest/stockmanagement/stock.
Parameterspagesort_bysort_orderupdated_toupdated_fromvariation_iditems_per_page
plentymarkets_list_warehouses
List warehouses
List the warehouses (id, name, type, priority, address settings). GET /rest/stockmanagement/warehouses.
Takes no parameters.
plentymarkets_list_contacts
List contacts
List contacts (customers, suppliers, ...). Returns personal data of your customers (names, emails, addresses). Filter by email, name, number, type, postal code or town; `with` adds addresses, options (email, phone), accounts, orderSummary. GET /rest/accounts/contacts.
Parametersnamepagetownwithemailnumbertype_idfull_textpostal_codecreated_afterupdated_aftercreated_before+4 more
plentymarkets_get_contact
Get a contact
Get one contact by id (customer personal data). Add addresses or accounts with `with` (the relations documented for this single-contact route). GET /rest/accounts/contacts/{contactId}.
Parameterswithcontact_idrequired
plentymarkets_update_order_status
Change an order's status
WRITE: move an order to another status. This can trigger the event procedures configured in the system (customer emails, stock bookings, documents, shipping), so confirm the target status with the user first (plentymarkets_list_order_statuses has the ids). Only the status is sent. PUT /rest/orders/{orderId}.
Parametersorder_idrequiredstatus_idrequired