Update Purchase Order

SecurityAPIKeyHeader
Request
path Parameters
order_id
required
string (Order Id)
Request Body schema: application/json
required
custom_data
object (Custom Data)

Key-value pair of custom data. See the custom_data guide

order_type
string (Order Type)
Default: "PURCHASE_ORDER"

Type of the order

Value: "PURCHASE_ORDER"
order_number
required
string (Order Number) <= 64 characters

Freeform text that can be anything the user wants, but must be unique.

description
string (Description)
Array of objects (References)
Default: []
start_date
string <date> (Start Date)
expiration_date
string <date> (Expiration Date)
name
string (Name)

Name of the purchase order

supplier_created_releases_allowed
boolean (Supplier Created Releases Allowed)
Default: false

Whether or not the supplier can create releases

object (Shipping Requirements)

Shipping requirements

tags
Array of strings (Tags)
Default: []

List of tags ids or slugs to be associated with the Order

groups
Array of strings (Groups)

List of group external IDs to be associated with the Order

object (OrderSupplier)

Another entity/company that is involved. IS NOT specific to any realm, meaning it does not reference any realm-specific ID values. Use this when you want multiple tenants to see the same data about a party.

object (OrderStop)
object (OrderStop)
Array of UpdateEntireOrderItem (object) or CreateOrderItem (object) (Items)
Responses
200

Successful Response

Response Schema: application/json
custom_data
object (Custom Data)

Key-value pair of custom data. See the custom_data guide

order_number
required
string (Order Number) <= 64 characters

Freeform text that can be anything the user wants, but must be unique.

required
object (OrderStop)
name
string (Name)

Name of order

object (OrderStop)
description
string (Description)
source
string (CreatedBySource)

READONLY - This is determined and automatically set by the platform.

Enum: "SHIPWELL_WEB" "IMPORT" "TENDER" "SHIPWELL_WEB_UNAUTH" "OTHER"
source_system_id
string (Source System Id) <= 64 characters
Deprecated

This field is deprecated and will be removed. It is not utilized.

start_date
string <date> (Start Date)

ISO 8601 date. See the date/time format documentation.

expiration_date
string <date> (Expiration Date)

ISO 8601 date. See the date/time format documentation.

Array of objects (References)
Default: []
object (Shipping Requirements)

Shipping requirements

id
required
string (Id)

Unique identifier for the Order

order_type
string (Order Type)
Default: "PURCHASE_ORDER"

Type of the order

Value: "PURCHASE_ORDER"
status
required
string (PurchaseOrderStatus)

READONLY - This is determined and automatically set by the platform. Status of the Purchase Order. See the order status guide

Enum: "NOT_READY" "READY" "FILLED" "ASSIGNED" "CANCELLED" "DISPATCHED" "IN_TRANSIT" "OUT_FOR_DELIVERY" "DELIVERED"
Array of objects (Items)
Default: []

Items on the Order

supplier_created_releases_allowed
boolean (Supplier Created Releases Allowed)
Default: false

Whether or not the supplier can create releases

object (Supplier)

Supplier for the Purchase Order

Array of any (Releases)
Default: []

List of Releases associated with the Order

released_from_release_id
string (Released From Release Id)

ID of this order's parent Release, if exists

created_from_order_id
string (Created From Order Id)

ID of this Order's parent Order, if exists

cancelled_at
string <date-time> (Cancelled At)

ISO 8601 date/time of when this Order was cancelled. See the date/time format documentation.

created_at
required
string <date-time> (Created At)

ISO 8601 date/time of when this Order was created. See the date/time format documentation.

updated_at
required
string <date-time> (Updated At)

ISO 8601 date/time of when this Order was last updated. See the date/time format documentation.

Array of objects (Tags)
Default: []

List of tags associated with the Order

Array of objects (Groups)
Default: []

List of groups associated with the Order

archived
boolean (Archived)
Default: false
400

Validation Error

put/purchase-orders/{order_id}
Request samples
application/json
{
  • "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
  • "order_type": "PURCHASE_ORDER",
  • "order_number": "string",
  • "description": "string",
  • "references": [ ],
  • "start_date": "2019-08-24",
  • "expiration_date": "2019-08-24",
  • "name": "string",
  • "supplier_created_releases_allowed": false,
  • "shipping_requirements": {
    },
  • "tags": [ ],
  • "groups": [
    ],
  • "supplier": {
    },
  • "ship_to": {
    },
  • "ship_from": {
    },
  • "items": [
    ]
}
Response samples
application/json
{
  • "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
  • "order_number": "string",
  • "ship_to": {
    },
  • "name": "string",
  • "ship_from": {
    },
  • "description": "string",
  • "source": "SHIPWELL_WEB",
  • "source_system_id": "string",
  • "start_date": "2019-08-24",
  • "expiration_date": "2019-08-24",
  • "references": [ ],
  • "shipping_requirements": {
    },
  • "id": "string",
  • "order_type": "PURCHASE_ORDER",
  • "status": "NOT_READY",
  • "items": [ ],
  • "supplier_created_releases_allowed": false,
  • "supplier": {
    },
  • "releases": [ ],
  • "released_from_release_id": "string",
  • "created_from_order_id": "string",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tags": [ ],
  • "groups": [ ],
  • "archived": false
}
Copyright © Shipwell 2025. All right reserved.