Create Purchase Order | ShipBob Developer API

curl -X POST https://sandbox-api.shipbob.com/Experimental/purchase-orders \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "external_reference": "string",
  "line_items": [
    {
      "external_sku": "string",
      "qty_expected": 1,
      "description": "string",
      "expiration_date": "2027-01-31",
      "inventory_id": 0,
      "lot_number": "string"
    }
  ],
  "notes": "string",
  "supplier_id": 1
}'

{
  "created_at": "2019-08-24T14:15:22+00:00",
  "external_reference": "string",
  "line_items": [
    {
      "description": "string",
      "expiration_date": "2027-01-31",
      "external_sku": "string",
      "inventory_id": 0,
      "lot_number": "string",
      "purchase_order_line_item_id": 0,
      "qty_expected": 0
    }
  ],
  "notes": "string",
  "purchase_order_id": 0,
  "status": {
    "id": 1,
    "name": "Draft"
  },
  "supplier": {
    "id": 0,
    "name": "string"
  },
  "updated_at": "2019-08-24T14:15:22+00:00"
}

Creates a purchase order in Draft. The external reference must be unique among the merchant's purchase orders that are not cancelled.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Request

The purchase order to create

external_referencestringRequired>=1 character

The merchant’s own reference; must be unique among the merchant’s non-cancelled purchase orders.

line_itemslist of objectsRequired

The expected line items.

notesstring or nullOptional

Free-text notes.

supplier_idinteger or nullOptional

Id of one of the merchant's suppliers.

Response

Created

created_atdatetimeOptional

When the purchase order was created (UTC).

external_referencestring or nullOptional

The merchant’s own reference, unique among the merchant’s non-cancelled purchase orders.

line_itemslist of objects or nullOptional

The expected line items.

notesstring or nullOptional

Free-text notes.

purchase_order_idlongOptional

Unique id of the purchase order.

statusobjectOptional

A purchase order status.

supplierobject or nullOptional

The supplier, or null when none is set.

updated_atdatetimeOptional

When the purchase order was last changed (UTC).

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error