Skip to content
Veeqo, An Amazon company Developers
Login Signup

List All Purchase Orders

GET
/purchase_orders

Parameters

Query Parameters

page_size
integer
default: 12

Amount of results

Example
25
page
integer
default: 1

Page to show

Example
1
show_complete
boolean
default: false
Example
false

Header Parameters

x-api-key
string

E.g. 123

Example
123

Responses

200

OK

Array<object>
object
actual_delivery_days
nullable
actual_return_days
nullable
arrival_at_calc
nullable
completed_at
nullable
created_at
string
created_by_id
number
destination_warehouse_id
number
estimated_delivery_days
number
estimated_return_days
nullable
id
number
line_items
Array<object>
object
cost
number
id
number
product_variant
object
active_channels
Array
allocated_stock_level_at_all_warehouses
number
available_stock_level_at_all_warehouses
number
channel_sellables
Array
cost_price
number
created_at
string
created_by_id
number
full_title
string
id
number
images
Array
inventory
object
allocated_stock_level_at_all_warehouses
number
available_stock_level_at_all_warehouses
number
incoming_stock_level_at_all_warehouses
number
infinite
boolean
physical_stock_level_at_all_warehouses
number
margin
number
measurement_attributes
object
depth
number
dimensions_unit
string
height
number
id
number
width
number
min_reorder_level
number
model_number
string
on_hand_value
number
price
number
product
object
description
string
estimated_delivery
nullable
hs_tariff_number
nullable
id
number
main_image
object
binary_data
nullable
content_type
nullable
created_at
string
created_by_id
nullable
deleted_at
nullable
deleted_by_id
nullable
display_position
nullable
id
number
picture_content_type
nullable
picture_file_name
nullable
picture_file_size
nullable
picture_order
number
picture_updated_at
nullable
product_id
number
src
string
updated_at
string
updated_by_id
nullable
main_image_src
string
origin_country
nullable
tax_rate
number
title
string
weight
number
product_title
string
profit
number
quantity_to_reorder
number
sellable_title
string
sku_code
string
stock_entries
Array<object>
object
allocated_stock_level
number
available_stock_level
number
incoming_stock_level
number
infinite
boolean
location
nullable
physical_stock_level
number
sellable_id
number
sellable_on_hand_value
number
stock_running_low
boolean
updated_at
string
warehouse
object
address_line_1
string
address_line_2
string
city
string
click_and_collect_days
nullable
click_and_collect_enabled
boolean
country
nullable
created_at
string
created_by_id
number
default_min_reorder
number
deleted_at
nullable
deleted_by_id
nullable
id
number
inventory_type_code
string
name
string
phone
nullable
post_code
string
region
string
requested_carrier_account
nullable
updated_at
string
updated_by_id
nullable
user_id
nullable
warehouse_id
number
stock_level_at_all_warehouses
number
tax_rate
number
title
string
total_quantity_sold
number
type
string
upc_code
string
updated_at
string
variant_option_specifics
Array
variant_property_specifics
Array
weight
number
quantity
number
received
nullable
received_at
nullable
number
string
received_at
nullable
returned_at
nullable
send_to_supplier
boolean
started_at
nullable
started_or_returned_at_calc
nullable
state
string
supplier
object
accounting_contact_email
string
accounting_contact_name
string
accounting_phone_number
nullable
address_line_1
string
address_line_2
string
bank_account_number
nullable
bank_name
nullable
bank_sort_code
nullable
city
string
country
string
created_at
string
created_by_id
number
credit_limit
number
currency_code
string
deleted_at
nullable
deleted_by_id
nullable
id
number
name
string
post_code
string
region
string
sales_contact_email
string
sales_contact_name
string
sales_phone_number
nullable
updated_at
string
updated_by_id
nullable
supplier_id
number
total_calc
number
updated_at
string
updated_by_id
nullable
user_id
number
Example
[
  {
    "actual_delivery_days": null,
    "actual_return_days": null,
    "arrival_at_calc": null,
    "completed_at": null,
    "created_at": "2016-05-28T21:34:51Z",
    "created_by_id": 1923,
    "destination_warehouse_id": 1784,
    "estimated_delivery_days": 1,
    "estimated_return_days": null,
    "id": 491,
    "line_items": [
      {
        "cost": 10,
        "id": 1575,
        "product_variant": {
          "active_channels": [],
          "allocated_stock_level_at_all_warehouses": 1,
          "available_stock_level_at_all_warehouses": 4,
          "channel_sellables": [],
          "cost_price": 0,
          "created_at": "2016-03-21T11:42:56Z",
          "created_by_id": 1923,
          "full_title": "APPLE MAGIC MOUSE [TEST]",
          "id": 1226617,
          "images": [],
          "inventory": {
            "allocated_stock_level_at_all_warehouses": 1,
            "available_stock_level_at_all_warehouses": 4,
            "incoming_stock_level_at_all_warehouses": 0,
            "infinite": false,
            "physical_stock_level_at_all_warehouses": 5
          },
          "margin": 100,
          "measurement_attributes": {
            "depth": 0,
            "dimensions_unit": "cm",
            "height": 0,
            "id": 622146,
            "width": 0
          },
          "min_reorder_level": 5,
          "model_number": "",
          "on_hand_value": 0,
          "price": 25.99,
          "product": {
            "description": "",
            "estimated_delivery": null,
            "hs_tariff_number": null,
            "id": 574314,
            "main_image": {
              "binary_data": null,
              "content_type": null,
              "created_at": "2016-03-21T11:42:57Z",
              "created_by_id": null,
              "deleted_at": null,
              "deleted_by_id": null,
              "display_position": null,
              "id": 795409,
              "picture_content_type": null,
              "picture_file_name": null,
              "picture_file_size": null,
              "picture_order": 9999,
              "picture_updated_at": null,
              "product_id": 574314,
              "src": "https://veeqo-production-storage.s3.amazonaws.com/images/1943652/212ke3aqQ1L_original.jpg",
              "updated_at": "2016-03-21T11:42:57Z",
              "updated_by_id": null
            },
            "main_image_src": "https://veeqo-production-storage.s3.amazonaws.com/images/1943652/212ke3aqQ1L_original.jpg",
            "origin_country": null,
            "tax_rate": 0,
            "title": "APPLE MAGIC MOUSE [TEST]",
            "weight": 0
          },
          "product_title": "APPLE MAGIC MOUSE [TEST]",
          "profit": 25.99,
          "quantity_to_reorder": 0,
          "sellable_title": "",
          "sku_code": "MB829Z/A",
          "stock_entries": [
            {
              "allocated_stock_level": 1,
              "available_stock_level": 4,
              "incoming_stock_level": 0,
              "infinite": false,
              "location": null,
              "physical_stock_level": 5,
              "sellable_id": 1226617,
              "sellable_on_hand_value": 0,
              "stock_running_low": true,
              "updated_at": "2016-03-21T11:42:58Z",
              "warehouse": {
                "address_line_1": "",
                "address_line_2": "",
                "city": "",
                "click_and_collect_days": null,
                "click_and_collect_enabled": false,
                "country": null,
                "created_at": "2016-03-21T11:42:55Z",
                "created_by_id": 1923,
                "default_min_reorder": 0,
                "deleted_at": null,
                "deleted_by_id": null,
                "id": 1784,
                "inventory_type_code": "wavg",
                "name": "My Warehouse",
                "phone": null,
                "post_code": "",
                "region": "",
                "requested_carrier_account": null,
                "updated_at": "2016-03-21T11:42:55Z",
                "updated_by_id": null,
                "user_id": null
              },
              "warehouse_id": 1784
            }
          ],
          "stock_level_at_all_warehouses": 5,
          "tax_rate": 0,
          "title": "Default",
          "total_quantity_sold": 1,
          "type": "ProductVariant",
          "upc_code": "",
          "updated_at": "2016-04-26T17:30:12Z",
          "variant_option_specifics": [],
          "variant_property_specifics": [],
          "weight": 0
        },
        "quantity": 1,
        "received": null,
        "received_at": null
      }
    ],
    "number": "PO-0000001",
    "received_at": null,
    "returned_at": null,
    "send_to_supplier": false,
    "started_at": null,
    "started_or_returned_at_calc": null,
    "state": "pending",
    "supplier": {
      "accounting_contact_email": "",
      "accounting_contact_name": "",
      "accounting_phone_number": null,
      "address_line_1": "",
      "address_line_2": "",
      "bank_account_number": null,
      "bank_name": null,
      "bank_sort_code": null,
      "city": "",
      "country": "",
      "created_at": "2016-03-21T11:42:55Z",
      "created_by_id": 1923,
      "credit_limit": 0,
      "currency_code": "gbp",
      "deleted_at": null,
      "deleted_by_id": null,
      "id": 1748,
      "name": "Default supplier",
      "post_code": "",
      "region": "",
      "sales_contact_email": "",
      "sales_contact_name": "",
      "sales_phone_number": null,
      "updated_at": "2016-03-21T11:42:55Z",
      "updated_by_id": null
    },
    "supplier_id": 1748,
    "total_calc": 10,
    "updated_at": "2016-05-28T21:34:51Z",
    "updated_by_id": null,
    "user_id": 1923
  }
]

Headers

X-Total-Count
string
ETag
string
X-Request-Id
string