API Reference
  1. MRPeasy REST API
  2. Customer Orders

List customer orders

get
https://api.mrpeasy.com/rest/v1/customer-orders
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Database ID of the customer order.

string

A unique number to identify the customer order.

string

Reference of the customer order.

integer

Database ID of the customer.

string

A unique number to identify the customer.

string

A name of the customer.

string

Email address of the customer.

string

Customer or shipping address.

integer

Sales person who handles that customer order.

integer

Database ID of the account manager.

integer

Database ID of the pricelist.

string

A unique number to identify the pricelist.

string

A name of the pricelist.

integer

ID of customer order shipping address if it is selected in customer order details.

string

Shipping address as text.

status
array of objects

Status of customer order.

  • 10 - quotation
  • 20 - waiting for confirmation
  • 30 - confirmed
  • 40 - waiting for production
  • 50 - in production
  • 60 - ready for shipment
  • 70 - shipped
  • 80 - delivered
  • 85 - archived
  • 90 - cancelled

Arrays are supported, for example ?status[]=10&status[]=20.

status
part_status
array of objects

Product status of customer order.

  • 10 - not booked
  • 12 - not enough
  • 15 - requested
  • 20 - delayed
  • 25 - possibly delayed
  • 30 - expected on time
  • 40 - ready for shipment
  • 50 - delivered

Arrays are supported, for example ?part_status[]=10&part_status[]=20.

part_status
invoice_status
array of objects

Invoice status of customer order.

  • 10 - not invoiced
  • 20 - partially invoiced
  • 30 - invoiced

Arrays are supported, for example ?invoice_status[]=10&invoice_status[]=20.

invoice_status
Allowed:
payment_status
array of objects

Payment status of customer order.

  • 10 - not paid
  • 20 - partially paid
  • 30 - paid

Arrays are supported, for example ?payment_status[]=10&payment_status[]=20.

payment_status
Allowed:
string

A unique number to identify the stock lot.

string

Source manufacturing order or purchase order code.

string

Internal notes, any additional information about the order.

string

Delivery terms of the order.

string

Minimum total price of the customer order.

string

Maximum total price of the customer order.

string

Minimum total cost of the customer order.

string

Maximum total cost of the customer order.

string

Minimum profit of the customer order.

string

Maximum profit of the customer order.

string

Minimum markup or margin percentage.

string

Maximum markup or margin percentage.

string

Minimum prepayment amount.

string

Maximum prepayment amount.

integer

Minimum creation date and time as unix timestamp.

integer

Maximum creation date and time as unix timestamp.

integer

Minimum planned delivery date and time as unix timestamp.

integer

Maximum planned delivery date and time as unix timestamp.

integer

Minimum available-from date and time as unix timestamp.

integer

Maximum available-from date and time as unix timestamp.

integer

Minimum actual delivery date and time as unix timestamp.

integer

Maximum actual delivery date and time as unix timestamp.

string

A unique number to identify the stock item.

string

Name of the stock item.

string

Minimum ordered quantity.

string

Maximum ordered quantity.

string

Minimum shipped quantity.

string

Maximum shipped quantity.

Headers
string

Pagination range (e.g., items=0-99, items=200-249)

Responses

429

Rate limited - another request is running

Updated 4 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?