Fulfilment customers and the Picqer API

Customers of Picqer users that have fulfilment features enabled, can use the Picqer API on their own.

To manage fulfilment customers, see this page.

API keys

As a Picqer admin, you can create an API key that is limited to a specific fulfilment customer. Provide your customer with such a scoped API key and they can use the Picqer API by themselves. Only certain features will be enabled and only for their own products, orders, customers and linked objects.

Available endpoints

For fulfilment customers, only the following endpoints are available:

Customers

  • GET /customers
  • GET /customers/{id}
  • POST /customers
  • PUT /customers/{id}
  • DELETE /customers/{id}

  • GET /customers/{id}/addresses

  • POST /customers/{id}/addresses
  • PUT /customers/{id}/addresses/{idaddress}
  • DELETE /customers/{id}/addresses/{idaddress}

Products

  • GET /products
  • GET /products/{id}
  • POST /products
  • PUT /products/{id}
  • GET /products/{id}/stock
  • GET /products/{id}/stock/{idwarehouse}

  • GET /products/{id}/parts

  • POST /products/{id}/parts
  • GET /products/{id}/parts/{idproduct_part}
  • PUT /products/{id}/parts/{idproduct_part}
  • DELETE /products/{id}/parts/{idproduct_part}

  • GET /products/{id}/images

  • POST /products/{id}/images
  • DELETE /products/{id}/images/{idimage}

Stock history

  • GET /stockhistory
  • GET /stockhistory/{id}

Orders

  • GET /orders
  • GET /orders/{id}
  • GET /orders/{id}/productstatus
  • POST /orders
  • PUT /orders/{id}
  • POST /orders/{id}/process
  • DELETE /orders/{id}

  • GET /orders/{id}/products

  • POST /orders/{id}/products
  • GET /orders/{id}/products/{idorder_product}
  • PUT /orders/{id}/products/{idorder_product}
  • DELETE /orders/{id}/products/{idorder_product}

  • GET /orders/{id}/backorders

  • GET /orders/{id}/notes

  • POST /orders/{id}/notes

Picklists

  • GET /picklists
  • GET /picklists/{id}
  • GET /picklists/{id}/shipments

Backorders

  • GET /backorders
  • GET /backorders/{id}
  • DELETE /backorders/{id}

Purchase orders

  • GET /purchaseorders
  • GET /purchaseorders/{id}
  • POST /purchaseorders
  • PUT /purchaseorders/{id}

  • GET /purchaseorders/{id}/products

  • GET /purchaseorders/{id}/products/{idpurchaseorder_product}
  • POST /purchaseorders/{id}/products
  • PUT /purchaseorders/{id}/products/{idpurchaseorder_product}
  • DELETE /purchaseorders/{id}/products/{idpurchaseorder_product}

  • GET /purchaseorders/{id}/receipts

  • GET /purchaseorders/{id}/receipts/{idreceipt}

  • POST /purchaseorders/{id}/mark-as-purchased

  • POST /purchaseorders/{id}/cancel

Returns

  • GET /returns
  • GET /returns/{id}
  • POST /returns
  • PUT /returns/{id}

  • GET /returns/{id}/returned_products

  • POST /returns/{id}/returned_products
  • PUT /returns/{id}/returned_products/{id}
  • DELETE /returns/{id}/returned_products/{id}

  • GET /returns/{id}/replacement_products

  • POST /returns/{id}/replacement_products
  • PUT /returns/{id}/replacement_products/{id}
  • DELETE /returns/{id}/replacement_products/{id}

  • GET /returns/{id}/logs

  • POST /returns/{id}/logs

  • GET /return_reasons

  • GET /return_statuses

VAT Groups

  • GET /vatgroups
  • GET /vatgroups/{id}

Warehouses

  • GET /warehouses
  • GET /warehouses/{id}

Hooks

  • GET /hooks
  • GET /hooks/{id}
  • POST /hooks/{id}
  • DELETE /hooks/{id}

Shipping providers

  • GET /shippingproviders