Updates a specific purchase order.
1 min
PUT
/episerverapi/commerce/orders/{orderGroupId}
Path Parameters
- orderGroupIdinteger<int32>requiredDescriptionFormatint32
Body Parameters
- bodyPurchaseOrderModelDescription
- addressIdstringDescription
- affiliateIdstring<uuid>DescriptionFormatuuid
- billingCurrencystringDescription
- customerIdstring<uuid>DescriptionFormatuuid
- customerNamestringDescription
- handlingTotalnumber<double>DescriptionFormatdouble
- instanceIdstring<uuid>DescriptionFormatuuid
- marketIdstringDescription
- namestringrequiredDescription
- orderAddressesOrderAddressModel[]Description
- orderGroupAddressIdinteger<int32>DescriptionFormatint32
- namestringDescription
- firstNamestringDescription
- lastNamestringDescription
- organizationstringDescription
- line1stringDescription
- line2stringDescription
- citystringDescription
- statestringDescription
- countryCodestringDescription
- countryNamestringDescription
- postalCodestringDescription
- regionCodestringDescription
- regionNamestringDescription
- daytimePhoneNumberstringDescription
- eveningPhoneNumberstringDescription
- faxNumberstringDescription
- emailstringDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- orderFormsOrderFormModel[]Description
- shipmentsShipmentModel[]Description
- discountsModelDiscountModel[]Description
- discountIdinteger<int32>DescriptionFormatint32
- discountAmountnumber<double>DescriptionFormatdouble
- discountCodestringDescription
- discountNamestringDescription
- displayMessagestringDescription
- discountValuenumber<double>DescriptionFormatdouble
- shipmentIdinteger<int32>DescriptionFormatint32
- shippingMethodIdstring<uuid>DescriptionFormatuuid
- shippingMethodNamestringDescription
- shippingTaxnumber<double>DescriptionFormatdouble
- shippingAddressIdstringDescription
- shipmentTrackingNumberstringDescription
- shippingDiscountAmountnumber<double>DescriptionFormatdouble
- shippingSubTotalnumber<double>DescriptionFormatdouble
- shippingTotalnumber<double>DescriptionFormatdouble
- statusstringDescription
- prevStatusstringDescription
- pickListIdinteger<int32>DescriptionFormatint32
- subTotalnumber<double>DescriptionFormatdouble
- warehouseCodestringDescription
- lineItemsLineItemModel[]Description
- lineItemIdinteger<int32>DescriptionFormatint32
- codestringDescription
- displayNamestringDescription
- placedPricenumber<double>DescriptionFormatdouble
- extendedPricenumber<double>DescriptionFormatdouble
- discountedPricenumber<double>DescriptionFormatdouble
- quantitynumber<double>DescriptionFormatdouble
- returnQuantitynumber<double>DescriptionFormatdouble
- inventoryTrackingStatusInventoryTrackingStatus
- isInventoryAllocatedbooleanDescription
- isGiftbooleanDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- lineItemsLineItemModel[]Description
- lineItemIdinteger<int32>DescriptionFormatint32
- codestringDescription
- displayNamestringDescription
- placedPricenumber<double>DescriptionFormatdouble
- extendedPricenumber<double>DescriptionFormatdouble
- discountedPricenumber<double>DescriptionFormatdouble
- quantitynumber<double>DescriptionFormatdouble
- returnQuantitynumber<double>DescriptionFormatdouble
- inventoryTrackingStatusInventoryTrackingStatus
- isInventoryAllocatedbooleanDescription
- isGiftbooleanDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- paymentsPaymentModel[]
- amountnumber<double>Formatdouble
- authorizationCodestring
- billingAddressIdstring
- customerNamestring
- implementationClassstring
- paymentIdinteger<int32>Formatint32
- paymentMethodIdstring<uuid>Formatuuid
- paymentMethodNamestring
- paymentTypeModelPaymentTypeModel
- statusstring
- transactionTypestring
- validationCodestring
- transactionIDstring
- providerTransactionIDstring
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- discountsDiscountModel[]Description
- discountIdinteger<int32>DescriptionFormatint32
- discountAmountnumber<double>DescriptionFormatdouble
- discountCodestringDescription
- discountNamestringDescription
- displayMessagestringDescription
- discountValuenumber<double>DescriptionFormatdouble
- returnCommentstringDescription
- returnTypestringDescription
- returnAuthCodestringDescription
- orderFormIdinteger<int32>DescriptionFormatint32
- namestringDescription
- billingAddressIdstringDescription
- shippingTotalnumber<double>DescriptionFormatdouble
- handlingTotalnumber<double>DescriptionFormatdouble
- taxTotalnumber<double>DescriptionFormatdouble
- discountAmountnumber<double>DescriptionFormatdouble
- subTotalnumber<double>DescriptionFormatdouble
- totalnumber<double>DescriptionFormatdouble
- statusstringDescription
- rmaNumberstringDescription
- authorizedPaymentTotalnumber<double>DescriptionFormatdouble
- capturedPaymentTotalnumber<double>DescriptionFormatdouble
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- orderGroupIdinteger<int32>DescriptionFormatint32
- orderNotesOrderNoteModel[]Description
- orderNoteIdinteger<int32>DescriptionFormatint32
- createdstring<date-time>DescriptionFormatdate-time
- customerIdstring<uuid>DescriptionFormatuuid
- detailstringDescription
- titlestringDescription
- typestringDescription
- lineItemIdinteger<int32>DescriptionFormatint32
- ownerstringDescription
- ownerOrgstringDescription
- providerIdstringDescription
- shippingTotalnumber<double>DescriptionFormatdouble
- statusstringDescription
- subTotalnumber<double>DescriptionFormatdouble
- taxTotalnumber<double>DescriptionFormatdouble
- totalnumber<double>DescriptionFormatdouble
- modifiedstring<date-time>DescriptionFormatdate-time
- createdstring<date-time>DescriptionFormatdate-time
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- orderNumberstringDescription
- returnFormsReturnOrderFormModel[]Description
- shipmentsShipmentModel[]Description
- discountsModelDiscountModel[]Description
- discountIdinteger<int32>DescriptionFormatint32
- discountAmountnumber<double>DescriptionFormatdouble
- discountCodestringDescription
- discountNamestringDescription
- displayMessagestringDescription
- discountValuenumber<double>DescriptionFormatdouble
- shipmentIdinteger<int32>DescriptionFormatint32
- shippingMethodIdstring<uuid>DescriptionFormatuuid
- shippingMethodNamestringDescription
- shippingTaxnumber<double>DescriptionFormatdouble
- shippingAddressIdstringDescription
- shipmentTrackingNumberstringDescription
- shippingDiscountAmountnumber<double>DescriptionFormatdouble
- shippingSubTotalnumber<double>DescriptionFormatdouble
- shippingTotalnumber<double>DescriptionFormatdouble
- statusstringDescription
- prevStatusstringDescription
- pickListIdinteger<int32>DescriptionFormatint32
- subTotalnumber<double>DescriptionFormatdouble
- warehouseCodestringDescription
- lineItemsLineItemModel[]Description
- lineItemIdinteger<int32>DescriptionFormatint32
- codestringDescription
- displayNamestringDescription
- placedPricenumber<double>DescriptionFormatdouble
- extendedPricenumber<double>DescriptionFormatdouble
- discountedPricenumber<double>DescriptionFormatdouble
- quantitynumber<double>DescriptionFormatdouble
- returnQuantitynumber<double>DescriptionFormatdouble
- inventoryTrackingStatusInventoryTrackingStatus
- isInventoryAllocatedbooleanDescription
- isGiftbooleanDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- lineItemsLineItemModel[]Description
- lineItemIdinteger<int32>DescriptionFormatint32
- codestringDescription
- displayNamestringDescription
- placedPricenumber<double>DescriptionFormatdouble
- extendedPricenumber<double>DescriptionFormatdouble
- discountedPricenumber<double>DescriptionFormatdouble
- quantitynumber<double>DescriptionFormatdouble
- returnQuantitynumber<double>DescriptionFormatdouble
- inventoryTrackingStatusInventoryTrackingStatus
- isInventoryAllocatedbooleanDescription
- isGiftbooleanDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- paymentsPaymentModel[]
- amountnumber<double>Formatdouble
- authorizationCodestring
- billingAddressIdstring
- customerNamestring
- implementationClassstring
- paymentIdinteger<int32>Formatint32
- paymentMethodIdstring<uuid>Formatuuid
- paymentMethodNamestring
- paymentTypeModelPaymentTypeModel
- statusstring
- transactionTypestring
- validationCodestring
- transactionIDstring
- providerTransactionIDstring
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- discountsDiscountModel[]Description
- discountIdinteger<int32>DescriptionFormatint32
- discountAmountnumber<double>DescriptionFormatdouble
- discountCodestringDescription
- discountNamestringDescription
- displayMessagestringDescription
- discountValuenumber<double>DescriptionFormatdouble
- returnCommentstringDescription
- returnTypestringDescription
- returnAuthCodestringDescription
- orderFormIdinteger<int32>DescriptionFormatint32
- namestringDescription
- billingAddressIdstringDescription
- shippingTotalnumber<double>DescriptionFormatdouble
- handlingTotalnumber<double>DescriptionFormatdouble
- taxTotalnumber<double>DescriptionFormatdouble
- discountAmountnumber<double>DescriptionFormatdouble
- subTotalnumber<double>DescriptionFormatdouble
- totalnumber<double>DescriptionFormatdouble
- statusstringDescription
- rmaNumberstringDescription
- authorizedPaymentTotalnumber<double>DescriptionFormatdouble
- capturedPaymentTotalnumber<double>DescriptionFormatdouble
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- originalOrderFormIdinteger<int32>DescriptionFormatint32
- exchangeOrderGroupIdinteger<int32>DescriptionFormatint32
Responses
200
204
400
401
404
curl
curl --request PUT \
--url /episerverapi/commerce/orders/{orderGroupId} \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"name": ""
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"name": ""
});
var requestOptions = {
method: 'PUT',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("/episerverapi/commerce/orders/{orderGroupId}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("/episerverapi/commerce/orders/{orderGroupId}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"name": ""
})
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "/episerverapi/commerce/orders/{orderGroupId}"
payload = json.dumps({
"name": ""
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
200
// Success
204
// The order is saved.
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.