Skip to content
/
Update an order

Update an order

Request

Partial update of an order's header fields. Rejected with 403 when the order's current workflow step is read-only for the caller's user type.

Accepts user session headers only.

Security
UserGuid and UserToken and SupplierGuid
Path
orderGuidstring, (uuid)required

GUID of the order.

Bodyapplication/jsonrequired
namestring
po_nostring
notestring
internal_notestring
invoice_nostring
vendor_idinteger
catalog_idinteger
price_group_idinteger or null
project_idinteger
client_idinteger
is_sampleboolean
is_on_holdboolean
is_cancelledboolean
is_local_deliveryboolean
shippingnumber
clear_manual_shipping_feeboolean
labornumber
price_adjustmentnumber
discountnumber
discount_type_idinteger
tax_rate_overridenumber or null
Ship_Toobject(AddressInput)

Address fields accepted when creating or updating an address.

save_address_to_vendorboolean

Also save Ship_To as the customer's default shipping address.

shipping_warehouse_idinteger
workflow_idinteger or null
allow_substitutionsboolean
allow_backordersboolean
approve_declinestring or null

Approve or decline a quote.

Enum:"APPROVE""DECLINE"null
tagsArray of integers or null
do_not_ship_before_datestring or null, (date)
cancel_datestring or null, (date)
assignedUsersArray of objects
detailsobject

Supplier-specific extra order fields.

curl -i -X PUT \
  'https://docs.orderwerks.com/_mock/openapi/v1/orders/{orderGuid}' \
  -H 'Content-Type: application/json' \
  -H 'supplierGuid: YOUR_API_KEY_HERE' \
  -H 'userGuid: YOUR_API_KEY_HERE' \
  -H 'userToken: YOUR_API_KEY_HERE' \
  -d '{
    "po_no": "PO-77812",
    "note": "Deliver to the rear dock."
  }'

Responses

The updated order.

Bodyapplication/json
idinteger
guidstring, (uuid)
namestring

Order number as displayed, e.g. ABC-10000.

api_guidstring or null

Client-supplied idempotency key, when the order was created through the API.

supplier_idinteger
vendor_idinteger or null
user_idinteger or null
catalog_idinteger or null
price_group_idinteger or null
category_idinteger or null
parent_order_idinteger or null
client_idinteger or null
project_idinteger or null
sales_rep_idinteger or null
ship_to_idinteger or null
order_state_idinteger

Current workflow state id (1 = PRELIMINARY, 2 = SUBMITTED, 8 = SHIPPED, 9 = COMPLETED, 23 = CANCELLED, ...).

order_source_idinteger or null

Origin of the order (1 = ORDERWERKS, 20 = OTHER, 21 = APP, ...).

po_nostring or null
invoice_nostring or null
descriptionstring or null
notestring or null
internal_notestring or null
shipping_instructionsstring or null
is_quoteboolean
is_sampleboolean
is_local_pickupboolean
is_local_deliveryboolean
is_shippedboolean
partially_shippedboolean
is_on_holdboolean
is_cancelledboolean
sub_totalnumber or null
taxnumber or null
shippingnumber or null
labornumber or null
discountnumber or null
discount_totalnumber or null
othernumber or null
grand_totalnumber or null
delivery_datestring or null
ship_datestring or null
do_not_ship_before_datestring or null
created_atstring, (date-time)
updated_atstring, (date-time)
Order_ItemsArray of objects(OrderItem)
Ship_Toobject(Address)

A billing or shipping address. Additional internal fields may be present.

Vendorobject(Vendor)

A customer of the supplier. The full model includes many integration-specific fields (QuickBooks, Stripe, FastBound, routing); only the commonly used ones are listed here.

Catalogobject(Catalog)
Price_Groupobject(PriceGroup)
Categoryobject(Category)
Order_Stateobject
Userobject

User who created the order.

Supplierobject
Clientobject or null

End client on behalf of whom the customer placed the order, if any.

Parent_Orderobject or null
Order_Detailobject or null

Supplier-specific extra fields.

Order_State_LogsArray of objects

State transition history.

Assigned_UsersArray of objects
Response
{
  "id": 0,
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "name": "string",
  "api_guid": "string",
  "supplier_id": 0,
  "vendor_id": 0,
  "user_id": 0,
  "catalog_id": 0,
  "price_group_id": 0,
  "category_id": 0,
  "parent_order_id": 0,
  "client_id": 0,
  "project_id": 0,
  "sales_rep_id": 0,
  "ship_to_id": 0,
  "order_state_id": 0,
  "order_source_id": 0,
  "po_no": "string",
  "invoice_no": "string",
  "description": "string",
  "note": "string",
  "internal_note": "string",
  "shipping_instructions": "string",
  "is_quote": true,
  "is_sample": true,
  "is_local_pickup": true,
  "is_local_delivery": true,
  "is_shipped": true,
  "partially_shipped": true,
  "is_on_hold": true,
  "is_cancelled": true,
  "sub_total": 0,
  "tax": 0,
  "shipping": 0,
  "labor": 0,
  "discount": 0,
  "discount_total": 0,
  "other": 0,
  "grand_total": 0,
  "delivery_date": "string",
  "ship_date": "string",
  "do_not_ship_before_date": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "Order_Items": [
    {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "order_id": 0,
      "catalog_item_id": 0,
      "catalog_item_guid": "4f58ba30-26c2-4deb-8240-21c2b978c5f5",
      "parent_order_item_id": 0,
      "item_no": 0,
      "sku": "string",
      "name": "string",
      "description": "string",
      "qty": 0,
      "qty_shipped": 0,
      "qty_backordered": 0,
      "qty_pending": 0,
      "qty_reserved": 0,
      "is_manual_price": true,
      "list_price_frozen": 0,
      "net_price": 0,
      "discount": 0,
      "discount_total": 0,
      "tax": 0,
      "total": 0,
      "is_credit": true,
      "is_backordered": true,
      "note": "string",
      "width": 0,
      "height": 0,
      "depth": 0,
      "selected_options": [ … ],
      "Catalog_Item": { … },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "Ship_To": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "vendor_id": 0,
    "order_id": 0,
    "name": "string",
    "company_name": "string",
    "address_line_one": "string",
    "address_line_two": "string",
    "address_line_three": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "string",
    "phone": "string",
    "fax": "string",
    "email": "string",
    "note": "string",
    "address_internal_id": "string",
    "is_vendor_main_ship_to": true,
    "verified": true,
    "lat": 0,
    "lng": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "Vendor": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "supplier_id": 0,
    "parent_vendor_id": 0,
    "customer_internal_id": "string",
    "name": "string",
    "email": "string",
    "shipping_email": "string",
    "phone": "string",
    "cell": "string",
    "fax": "string",
    "address_line_one": "string",
    "address_line_two": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "string",
    "active": true,
    "tax_exempt": true,
    "resale_tax_id": "string",
    "lock_catalog_id": 0,
    "price_group_id": 0,
    "payment_type_id": 0,
    "payment_term_id": 0,
    "require_payment": true,
    "credit_limit": 0,
    "open_balance": 0,
    "is_ecomm_user": true,
    "net_term_ecomm_user": true,
    "require_po": true,
    "standing_po": "string",
    "hide_pricing": true,
    "currency_id": 0,
    "notes": "string",
    "default_order_category_id": 0,
    "route_id": 0,
    "timezone": "string",
    "bill_to_id": 0,
    "ship_to_id": 0,
    "Bill_To": {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "vendor_id": 0,
      "order_id": 0,
      "name": "string",
      "company_name": "string",
      "address_line_one": "string",
      "address_line_two": "string",
      "address_line_three": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "string",
      "phone": "string",
      "fax": "string",
      "email": "string",
      "note": "string",
      "address_internal_id": "string",
      "is_vendor_main_ship_to": true,
      "verified": true,
      "lat": 0,
      "lng": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "Ship_To": {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "vendor_id": 0,
      "order_id": 0,
      "name": "string",
      "company_name": "string",
      "address_line_one": "string",
      "address_line_two": "string",
      "address_line_three": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "string",
      "phone": "string",
      "fax": "string",
      "email": "string",
      "note": "string",
      "address_internal_id": "string",
      "is_vendor_main_ship_to": true,
      "verified": true,
      "lat": 0,
      "lng": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z"
  },
  "Catalog": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "supplier_id": 0,
    "name": "Main Catalog",
    "email": "string",
    "version": "string",
    "active": true,
    "order_item_type_id": 0,
    "currency_id": 0,
    "order_prefix_override": "string",
    "last_inventory_update": "2019-08-24T14:15:22Z",
    "Price_Groups": [
      { … }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "Price_Group": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "catalog_id": 0,
    "value": "Wholesale",
    "is_main": true,
    "percentage": 0,
    "price_upcharge_type_id": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z"
  },
  "Category": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "catalog_id": 0,
    "parent_category_id": 0,
    "name": "string",
    "sequence": 0,
    "hide_category": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "Order_State": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "name": "string"
  },
  "User": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "name": "string",
    "email": "string"
  },
  "Supplier": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "name": "string",
    "email": "string"
  },
  "Client": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "name": "string"
  },
  "Parent_Order": {
    "id": 0,
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "name": "string"
  },
  "Order_Detail": {},
  "Order_State_Logs": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "User": { … },
      "Order_State": { … }
    }
  ],
  "Assigned_Users": [
    {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "name": "string",
      "email": "string"
    }
  ]
}