Shipsidekick LogoShipsidekick Docs
API/Purchase orders

Get purchase order by ID

Retrieve a specific purchase order by its unique identifier. Results are filtered to purchase orders the authenticated user has access to.

GET
/purchase-orders/{purchaseOrderId}

Path Parameters

purchaseOrderIdRequiredstring

Unique identifier of the purchase order

Format: "uuid"
curl -X GET "https://www.shipsidekick.com/api/v1/purchase-orders/po-1234-5678-9abc-def0-123456789012"

Successful operation

{
  "object": "purchase-order",
  "data": {
    "id": "po-1234-5678-9abc-def0-123456789012",
    "organizationId": "org-5678-1234-abcd-efgh-987654321000",
    "name": "#PO-12345",
    "status": "confirmed",
    "supplierId": "supplier-1234-5678-9abc-def012345678",
    "subtotal": 1500,
    "totalTax": 150,
    "grandTotal": 1650,
    "currency": "usd",
    "paymentTerms": "Net 30",
    "trackingNumber": "1Z999AA1234567890",
    "referenceNumber": "REF-12345",
    "shippingCarrier": "UPS",
    "expectedDate": "2024-02-15T10:00:00Z",
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-01-16T14:30:00Z",
    "cancelledAt": null,
    "supplier": {
      "id": "supplier-1234-5678-9abc-def012345678",
      "organizationId": "org-5678-1234-abcd-efgh-987654321000",
      "name": "ACME Corp",
      "email": "orders@acmecorp.com",
      "phone": "+1-555-123-4567",
      "currency": "usd"
    },
    "warehouse": {
      "id": "warehouse-1234-5678-9abc-def012345678",
      "organizationId": "org-5678-1234-abcd-efgh-987654321000",
      "name": "Main Warehouse",
      "addressId": "address-1234-5678-9abc-def012345678",
      "isThirdParty": false,
      "sharedWithChildren": false
    },
    "lineItems": [
      {
        "id": "line-item-1234-5678-9abc-def012345678",
        "organizationId": "org-5678-1234-abcd-efgh-987654321000",
        "supplierProductId": "supplier-product-1234",
        "productVariantId": "variant-1234-5678-9abc-def012345678",
        "requestedQuantity": 10,
        "unitPrice": 150,
        "taxRate": 0.1,
        "subtotal": 1500,
        "productVariant": {
          "id": "variant-1234-5678-9abc-def012345678",
          "title": "Widget Pro",
          "sku": "WIDGET-PRO-001",
          "product": {
            "name": "Professional Widget",
            "brand": "WidgetCorp",
            "manufacturer": "WidgetCorp Manufacturing"
          }
        },
        "createdAt": "2024-01-15T10:00:00Z",
        "updatedAt": "2024-01-15T10:00:00Z",
        "purchaseOrderLineItemReceipts": []
      }
    ],
    "purchaseOrderReceipts": [],
    "tags": [
      {
        "id": "tag-1234-5678-9abc-def012345678",
        "name": "urgent"
      }
    ],
    "notes": [
      {
        "id": "note-1234-5678-9abc-def012345678",
        "content": "Please expedite this order",
        "type": "customer",
        "createdAt": "2024-01-15T10:00:00Z"
      }
    ]
  }
}

Update or move inventory POST

Update inventory quantities at a specific location or move inventory between warehouse locations

List purchase orders GET

Retrieve a list of purchase orders with pagination and filtering options. Results are filtered to purchase orders the authenticated user has access to.