Partially updates a specific purchase order.

patch http://localhost:64424/episerverapi/commerce/orders/{orderGroupId}

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

orderGroupId

int32

required

Purchase order id.

Body Params

Purchase order model.

OrderNumber

string

An order number used for tracking the order.

AddressId

string

Address ID.

AffiliateId

uuid

Affiliate ID (GUID).

BillingCurrency

string

Billing currency.

CustomerId

uuid

Customer ID (GUID).

CustomerName

string

Customer name.

HandlingTotal

double

Handling total.

InstanceId

uuid

Instance ID (GUID).

MarketId

string

Market ID.

Name

string

required

Order name.

OrderAddresses

array of objects

List of addresses.

OrderAddresses

OrderForms

array of objects

List of order forms.

OrderForms

OrderGroupId

int32

Order group ID.

OrderNotes

array of objects

List of order notes.

OrderNotes

Owner

string

Owner name.

OwnerOrg

string

Owner's organization name.

ProviderId

string

Provider ID.

ShippingTotal

double

Shipping total.

Status

string

Status.
Valid values:

AwaitingExchange
Cancelled
Completed
InProgress
OnHold
PartiallyShipped.

SubTotal

double

Sub-total.

TaxTotal

double

Tax total.

Total

double

Total.

Modified

date-time

Modified date.

Created

date-time

Created date.

Properties

array of objects

Gets the list of key value pairs for dealing with custom properties.

Properties

Responses

400

If the purchase order model is not valid.

401

If user does not have enough permission for this request.

404

If order does not exist.

Language

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url http://localhost:64424/episerverapi/commerce/orders/orderGroupId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Partially updates a specific purchase order.

204The order is saved.