Skip to content

Purchase orders

Returns list of purchase orders in the system. Returned data can be limited with start and end query parameters.

Operations

Download purchase orders as JSON

Request

GET https://api.zoined.com/v2/download/purchaseOrders.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
startstring

Return data starting from given date

Example:start=2017-01-01
endstring

Return data ending to given date

Example:end=2017-01-31
order_statusnumber

Return data with given order status only

Example:order_status=3
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/purchaseOrders.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
transaction_idstringrequired

Unique ID for the transaction

Example:"er/232/f31"
line_item_idstringrequired

Secondary transaction identifier

Example:"1"
product_idstringrequired

Product ID

Example:"XYZ"
supplier_idstring

Supplier ID

Example:"221"
parent_product_idstring

Parent Product ID

Example:"123"
ordered_quantitynumberrequired

Purchased quantity

Example:2
delivered_quantitynumber

Delivered quantity

Example:2
product_unit_pricenumber

Unit price including tax

Example:2.5
currencystring

Currency as ISO 4217 currency code. Required if multiple currencies are used.

Example:"EUR"
purchase_pricenumber

Total purchase price including tax

Example:5
purchase_price_wo_vatnumber

Total purchase price without tax

Example:4
rebatenumber

Amount of rebate given including tax

Example:0
rebate_wo_vatnumber

Amount of rebate given without tax

Example:0
retail_valuenumber

Total retail (sales) value including tax

Example:10
retail_value_wo_vatnumber

Total retail (sales) value without tax

Example:8
sales_unitstring

Unit of packaging

Example:"pcs"
gross_weightnumber

Total weight of this order item

Example:12.5
organisation_idstringrequired

Organisation unit ID

Example:"540"
department_idstring

Department ID

Example:"54011"
purchaser_idstring

Purchaser ID

Example:"5400"
order_datestringrequired

Order date (yyyy-mm-dd)

Example:"2016-01-01"
order_timestring

Order time (HH:mm:ss)

Example:"15:00:00"
delivery_datestring

Delivery date (yyyy-mm-dd)

Example:"2016-01-01"
delivery_timestring

Delivery time (HH:mm:ss)

Example:"15:00:00"
arrival_datestring

Arrival date (yyyy-mm-dd)

Example:"2016-01-03"
arrival_timestring

Arrival time (HH:mm:ss)

Example:"15:00:00"
order_statusnumberrequired

Order status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled

Example:1
order_typestring

Order Type

Example:"Express"
custom_field_1string

User defined custom field 1

Example:"extra info"
custom_field_2string

User defined custom field 2

Example:"extra info"
custom_field_3string

User defined custom field 3

Example:"extra info"
custom_field_4string

User defined custom field 4

Example:"extra info"
custom_field_5string

User defined custom field 5

Example:"extra info"
custom_field_6string

User defined custom field 6

Example:"extra info"
custom_field_7string

User defined custom field 7

Example:"extra info"
custom_field_8string

User defined custom field 8

Example:"extra info"
custom_field_9string

User defined custom field 9

Example:"extra info"
custom_field_10string

User defined custom field 10

Example:"extra info"
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
Response
{
  "transaction_id": "er/232/f31",
  "line_item_id": "1",
  "product_id": "XYZ",
  "supplier_id": "221",
  "parent_product_id": "123",
  "ordered_quantity": 2,
  "delivered_quantity": 2,
  "product_unit_price": 2.5,
  "currency": "EUR",
  "purchase_price": 5,
  "purchase_price_wo_vat": 4,
  "rebate": 0,
  "rebate_wo_vat": 0,
  "retail_value": 10,
  "retail_value_wo_vat": 8,
  "sales_unit": "pcs",
  "gross_weight": 12.5,
  "organisation_id": "540",
  "department_id": "54011",
  "purchaser_id": "5400",
  "order_date": "2016-01-01",
  "order_time": "15:00:00",
  "delivery_date": "2016-01-01",
  "delivery_time": "15:00:00",
  "arrival_date": "2016-01-03",
  "arrival_time": "15:00:00",
  "order_status": 1,
  "order_type": "Express",
  "custom_field_1": "extra info",
  "custom_field_2": "extra info",
  "custom_field_3": "extra info",
  "custom_field_4": "extra info",
  "custom_field_5": "extra info",
  "custom_field_6": "extra info",
  "custom_field_7": "extra info",
  "custom_field_8": "extra info",
  "custom_field_9": "extra info",
  "custom_field_10": "extra info",
  "custom_metric_1": 1,
  "custom_metric_2": 100,
  "custom_metric_3": 2.2,
  "custom_metric_4": 1.05,
  "custom_metric_5": 10000
}