Webshop Orders

A webshop order is used to view and import an order from a webshop integration into Picqer.

Attributes

Name	Type	Required	Description
idcompany_webshop_order	integer	generated	Unique identifier for the webshop order within Picqer
idcompany_webshop	integer	required	Linked to resource CompanyWebshop
idorder	integer	optional	Linked to resource Orders
foreign_id	string	required	Unique identifier of the order in the external webshop system
foreign_number	string	optional	Order number as displayed in the external webshop system
foreign_status	string	optional	Last known status of the order in the external webshop system
status	string	required	Current import status of the webshop order in Picqer (e.g., 'expected', 'importing', 'ignored', 'imported', 'error', 'canceled')
reason	string	optional	Additional information or reason for the current status (e.g., error message)
ordered	datetime	required	Date and time when the order was placed in the webshop
created	datetime	required	Date and time when the webshop order was created in Picqer
updated	datetime	required	Date and time when the webshop order was last updated in Picqer

Get all webshop orders

Retrieve a list of all webshop orders.

GET https://example.com/api/v1/webshoporders

HTTP/1.1 200 OK [ { "idcompany_webshop_order": 101, "idcompany_webshop": 1, "idorder": 5001, "foreign_id": "WEB12345", "foreign_number": "ORDER-2025-001", "foreign_status": "completed", "status": "imported", "reason": null, "ordered": "2025-07-10 10:00:00", "created": "2025-07-10 10:05:15", "updated": "2025-07-11 14:30:00" }, { "idcompany_webshop_order": 102, "idcompany_webshop": 2, "idorder": null, "foreign_id": "SHOP-ABC-6789", "foreign_number": "SO-2025-002", "foreign_status": "pending", "status": "expected", "reason": null, "ordered": "2025-07-12 09:30:00", "created": "2025-07-12 09:35:00", "updated": "2025-07-12 09:35:00" } ]

This endpoint uses pagination.

Get single webshop order

Retrieve details of a specific webshop order by its ID.

GET https://example.com/api/v1/webshoporders/{idcompany_webshop_order}

HTTP/1.1 200 OK { "idcompany_webshop_order": 101, "idcompany_webshop": 1, "idorder": 5001, "foreign_id": "WEB12345", "foreign_number": "ORDER-2025-001", "foreign_status": "paid", "status": "imported", "reason": null, "ordered": "2025-07-10 10:00:00", "created": "2025-07-10 10:05:15", "updated": "2025-07-11 14:30:00" }