Purchase Order - Get By Status

Retrieve purchase orders filtered by their current status.

GET /purchase_order/get_by_status

Purchase Order - Get By Status

cURL

curl --request GET \
  --url https://api.skulabs.com/purchase_order/get_by_status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.skulabs.com/purchase_order/get_by_status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.skulabs.com/purchase_order/get_by_status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skulabs.com/purchase_order/get_by_status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skulabs.com/purchase_order/get_by_status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.skulabs.com/purchase_order/get_by_status")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skulabs.com/purchase_order/get_by_status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "purchase_orders": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "number": "<string>",
      "account_id": "<string>",
      "distributor_id": "<string>",
      "log": [
        {
          "user_id": "507f1f77bcf86cd799439011",
          "action": "<string>",
          "details": {},
          "time": "2025-01-15T12:00:00.000Z"
        }
      ],
      "items": [
        {
          "item_id": "<string>",
          "kit_id": "<string>",
          "sku": "<string>",
          "name": "<string>",
          "quantity": 123,
          "received": 123,
          "cost": 123,
          "rate": 123,
          "serial_numbers": [
            "<string>"
          ],
          "description": "<string>",
          "unit": "<string>"
        }
      ],
      "custom_items": [
        {}
      ],
      "custom_adjustments": [
        {
          "name": "<string>",
          "amount": 123
        }
      ],
      "tracking": [
        {}
      ],
      "subtotal": 123,
      "total": 123,
      "tax": 123,
      "tax_per": 123,
      "shipping": 123,
      "discount": 123,
      "due_date": "2025-01-15",
      "arrival_date": "2025-01-15",
      "closed_date": "2025-01-15",
      "metadata": {},
      "discount_per": 123,
      "tags": [
        "507f1f77bcf86cd799439011",
        "507f1f77bcf86cd799439012"
      ],
      "store_id": "507f1f77bcf86cd799439011",
      "warehouse_id": "<string>",
      "memo": "<string>",
      "currency": "<string>",
      "terms": "<string>",
      "method": "<string>",
      "order_number": "<string>",
      "dropship_address": {},
      "dropshipped": true,
      "bol_pro_numbers": [
        "<string>"
      ]
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status · enum<string> · required

PO status to filter by

Available options: closed, created, receiving, acknowledged, sent, edited, transit, accepting

Response

200

application/json

Purchase orders by status

purchase_orders · object[] · required

Array of purchase orders

Show child attributes