Purchase Orders

List Purchase Orders

List purchase orders.

GET

/v1/purchase_orders

curl --request GET \
  --url 'https://public-api.bladepro.io/v1/purchase_orders?expand=%3Cstring%3E&product_channel_id%5BIN%5D=123&product_channel_id%5BNOT_IN%5D=123&product_component_supplier_id%5BIN%5D=123&product_component_supplier_id%5BNOT_IN%5D=123&status%5BIN%5D=%3Cany%3E&status%5BNOT_IN%5D=%3Cany%3E&purchase_order_type_id%5BIN%5D=123&purchase_order_type_id%5BNOT_IN%5D=123&completed_date%5BLESS_THAN%5D=%3Cany%3E&completed_date%5BON_DATE%5D=%3Cany%3E&completed_date%5BMORE_THAN%5D=%3Cany%3E&sorting=id'

{
  "data": {
    "approved_date": "2019-11-25T14:52:56.000Z",
    "channel": {
      "default_warehouse_id": 1,
      "global": false,
      "id": 1,
      "name": "Demo Channel"
    },
    "comments": "Sample comments.",
    "completed_date": "2019-11-25T14:52:56.000Z",
    "created": "2019-11-25T14:52:56.000Z",
    "currency": {
      "code": "GBP",
      "name": "British Pound",
      "symbol": "£"
    },
    "currency_id": 1,
    "discount": 0,
    "discount_type": "value",
    "goodsins": [
      {
        "booking_approved": "2019-11-25T14:52:56.000Z",
        "booking_approved_by": 1,
        "booking_requested": "2019-11-25T14:52:56.000Z",
        "check_in_by": "2019-11-25T14:52:56.000Z",
        "checkin_completed": "2019-11-25T14:52:56.000Z",
        "checkin_started": "2019-11-25T14:52:56.000Z",
        "container_shipment": true,
        "container_size": "full",
        "created": "2019-11-25T14:52:56.000Z",
        "expected_cartons": 3200,
        "expected_delivery_date": "2019-11-25T14:52:56.000Z",
        "expected_delivery_time_slot": "am",
        "expected_pallets": 32,
        "id": 174,
        "ignore_from_billing": false,
        "is_third_party": false,
        "items": [
          {
            "count_audit_ids": 0,
            "created": "2019-11-25T14:52:56.000Z",
            "expiry_date": null,
            "id": 123124,
            "modified": "2019-11-25T14:52:56.000Z",
            "product_component_batch_id": 52567,
            "product_component_cost_price_id": 54349,
            "product_component_id": 1,
            "purchase_order_goodsin_item_issue_id": 78,
            "quantity": 34
          }
        ],
        "lock_user_id": 1,
        "modified": "2019-11-25T14:52:56.000Z",
        "port_id": 4,
        "preferred_delivery_date": "2019-11-25T14:52:56.000Z",
        "preferred_delivery_time_slot": "am",
        "purchase_order_goodsin_shipping_term_id": 1,
        "putaway_completed": "2019-11-25T14:52:56.000Z",
        "putaway_started": "2019-11-25T14:52:56.000Z",
        "received_cartons": 3200,
        "received_container": "20FT",
        "received_pallets": 32,
        "receiving_completed": "2019-11-25T14:52:56.000Z",
        "receiving_started": "2019-11-25T14:52:56.000Z",
        "returns_damaged_count": 0,
        "returns_unidentifiable_count": 0,
        "shipping_company": "DHL",
        "shipping_method": "sea",
        "source": "API",
        "status": "completed",
        "third_party_contact_name": null,
        "third_party_emails": null,
        "tracking_number": "DHL-TN-1209341234",
        "transport_costs_locked": "2019-11-25T14:52:56.000Z",
        "unique_booking_reference": "UQBR-2020/10934934"
      }
    ],
    "id": 125,
    "modified": "2019-11-25T14:52:56.000Z",

Fuzzy search available

Scope(s): APP::PURCHASE-ORDERS::READ

Query Parameters

expandstringquery

Usage: expand=*

Expand channel, currency, goodsins, goodsins.items, references, supplier, supplier.currency, type, warehouse, warehouse.country

product_channel_id[IN]numberquery

Filter for id of the product channel. (IN)

product_channel_id[NOT_IN]numberquery

Filter for id of the product channel. (NOT_IN)

product_component_supplier_id[IN]numberquery

Filter for supplier id. (IN)

product_component_supplier_id[NOT_IN]numberquery

Filter for supplier id. (NOT_IN)

status[IN]anyquery

Filter for purchase order status. (IN)

status[NOT_IN]anyquery

Filter for purchase order status. (NOT_IN)

purchase_order_type_id[IN]numberquery

Filter for id of the purchase order type. (IN)

purchase_order_type_id[NOT_IN]numberquery

Filter for id of the purchase order type. (NOT_IN)

completed_date[LESS_THAN]anyquery

Filter for date of completion. (LESS_THAN)

completed_date[ON_DATE]anyquery

Filter for date of completion. (ON_DATE)

completed_date[MORE_THAN]anyquery

Filter for date of completion. (MORE_THAN)

sortingenum<string>query

Sort by id, warehouse.name, created (prefix with '-' for descending order).

Available options: id, -id, warehouse.name, -warehouse.name, created, -created

Response

successful operation

approved_dateany

Date the purchase order was accepted on.

channelobject

Product channel details.

Show child attributes

commentsstring

Comments.

completed_dateany

Date of completion.

createdany

Created date.

currencyobject

Currency.

currency_idnumber

Currency ID.

discountnumber

Discount amount.

discount_typeenum<string>

Discount type.

Available options: percentage, value

goodsinsany

List of goodsins.

idnumber

ID.

linesany

Ordered lines.

modifiedany

Last modified date.

notification_email_addressesstring

Notification email address.

paymentsany

Payments made to suppliers.

product_channel_idnumber

ID of the product channel.

product_component_supplier_idnumber

Supplier ID.

purchase_order_type_idnumber

ID of the purchase order type.

referencesany

List of references.

reject_reasonstring

Reason for rejecting the purchase order.

statusenum<string>

Purchase order status.

Available options: draft, cancelled, awaiting_approval, awaiting_booking, rejected, open, completed, discrepancies, pending_completion

supplierobject

Supplier.

Show child attributes

tagsany

List of applied tags.

typeobject

Purchase order type.

Show child attributes

warehouseobject

Warehouse.

warehouse_idnumber

Warehouse ID.

Still need help? Share an idea