--- title: Updates a specific purchase order. slug: commerce-connect-15/service-api/updates-a-specific-purchase-order docTags: createdAt: 2026-10-09T17:33:29.599Z --- { "id": "ss8dkM8ctRsMYZ8ovSr1f", "type": "api-oas-v2", "data": { "method": "PUT", "url": "/episerverapi/commerce/orders/{orderGroupId}", "servers": [], "name": "Updates a specific purchase order.", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "orderGroupId", "type": "integer", "description": "Purchase order id.", "format": "int32" } ], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "Purchase order model.", "customType": "PurchaseOrderModel", "schema": [ { "name": "addressId", "kind": "optional", "type": "string", "nullable": true, "description": "Address ID." }, { "name": "affiliateId", "kind": "optional", "type": "string", "description": "

Affiliate ID (GUID).

", "format": "uuid" }, { "name": "billingCurrency", "kind": "optional", "type": "string", "nullable": true, "description": "Billing currency." }, { "name": "customerId", "kind": "optional", "type": "string", "description": "

Customer ID (GUID).

", "format": "uuid" }, { "name": "customerName", "kind": "optional", "type": "string", "nullable": true, "description": "Customer name." }, { "name": "handlingTotal", "kind": "optional", "type": "number", "description": "Handling total.", "format": "double" }, { "name": "instanceId", "kind": "optional", "type": "string", "description": "

Instance ID (GUID).

", "format": "uuid" }, { "name": "marketId", "kind": "optional", "type": "string", "nullable": true, "description": "Market ID." }, { "name": "name", "kind": "required", "type": "string", "description": "Order name." }, { "name": "orderAddresses", "kind": "optional", "type": "array", "nullable": true, "description": "List of addresses.", "modelRef": "#/components/schemas/OrderAddressModel", "customType": "OrderAddressModel[]", "schema": [ { "name": "orderGroupAddressId", "kind": "optional", "type": "integer", "description": "Gets the order group address id.", "format": "int32" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the first name." }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets last name." }, { "name": "organization", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the organization." }, { "name": "line1", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the line1." }, { "name": "line2", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the line2." }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the city." }, { "name": "state", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the state." }, { "name": "countryCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the country code." }, { "name": "countryName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the country." }, { "name": "postalCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the postal code." }, { "name": "regionCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the region code." }, { "name": "regionName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the region." }, { "name": "daytimePhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the daytime phone number." }, { "name": "eveningPhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the evening phone number." }, { "name": "faxNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the fax number." }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the email." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "orderForms", "kind": "optional", "type": "array", "nullable": true, "description": "List of order forms.", "modelRef": "#/components/schemas/OrderFormModel", "customType": "OrderFormModel[]", "schema": [ { "name": "shipments", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the shipments.", "modelRef": "#/components/schemas/ShipmentModel", "customType": "ShipmentModel[]", "schema": [ { "name": "discountsModel", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the discounts.", "modelRef": "#/components/schemas/DiscountModel", "customType": "DiscountModel[]", "schema": [ { "name": "discountId", "kind": "optional", "type": "integer", "description": "Gets or sets the discount id.", "format": "int32" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. Either fixed money value or percentage.", "format": "double" }, { "name": "discountCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the discount code. Also known as a coupon code." }, { "name": "discountName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the discount." }, { "name": "displayMessage", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display message." }, { "name": "discountValue", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount\r\nif it is a fixed monetary value. For the percentage based discount this value will be different.", "format": "double" } ] }, { "name": "shipmentId", "kind": "optional", "type": "integer", "description": "Gets the shipment id.", "format": "int32" }, { "name": "shippingMethodId", "kind": "optional", "type": "string", "description": "Gets or sets the shipping method id.", "format": "uuid" }, { "name": "shippingMethodName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the shipping method." }, { "name": "shippingTax", "kind": "optional", "type": "number", "description": "Gets or sets the shipment tax.", "format": "double" }, { "name": "shippingAddressId", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the shipping address name." }, { "name": "shipmentTrackingNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the shipment tracking number." }, { "name": "shippingDiscountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the shipping discount amount.", "format": "double" }, { "name": "shippingSubTotal", "kind": "optional", "type": "number", "description": "Gets or sets the shipping sub total.", "format": "double" }, { "name": "shippingTotal", "kind": "optional", "type": "number", "description": "

Gets or sets the total shipping cost, including shipping discounts (if any) and shipping tax.

", "format": "double" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the status." }, { "name": "prevStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the previous status." }, { "name": "pickListId", "kind": "optional", "type": "integer", "nullable": true, "description": "Gets or sets the pick list id.", "format": "int32" }, { "name": "subTotal", "kind": "optional", "type": "number", "description": "Gets or sets the sub total.", "format": "double" }, { "name": "warehouseCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the warehouse code." }, { "name": "lineItems", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the collection of line items.", "modelRef": "#/components/schemas/LineItemModel", "customType": "LineItemModel[]", "schema": [ { "name": "lineItemId", "kind": "optional", "type": "integer", "description": "Gets the identity of the line item.", "format": "int32" }, { "name": "code", "kind": "optional", "type": "string", "nullable": true, "description": "Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content." }, { "name": "displayName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display name." }, { "name": "placedPrice", "kind": "optional", "type": "number", "description": "Gets the price for one item that this line item represent. This property don't take any discounts in consideration.", "format": "double" }, { "name": "extendedPrice", "kind": "optional", "type": "number", "description": "

Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.

", "format": "double" }, { "name": "discountedPrice", "kind": "optional", "type": "number", "description": "

Gets the line item discounted price. Only calculates the price with the \"line item discount amount,\" that is, the discount for a specific item.

", "format": "double" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Gets or sets the number of items this line item contains.", "format": "double" }, { "name": "returnQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the returned in stock quantity.", "format": "double" }, { "name": "inventoryTrackingStatus", "kind": "optional", "type": "integer", "description": "", "modelRef": "#/components/schemas/InventoryTrackingStatus", "customType": "InventoryTrackingStatus", "schema": [] }, { "name": "isInventoryAllocated", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance has allocated inventory for the EPiServer.Commerce.Order.ILineItem.Quantity." }, { "name": "isGift", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether the line item is a gift item." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "lineItems", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the line items.", "modelRef": "#/components/schemas/LineItemModel", "customType": "LineItemModel[]", "schema": [ { "name": "lineItemId", "kind": "optional", "type": "integer", "description": "Gets the identity of the line item.", "format": "int32" }, { "name": "code", "kind": "optional", "type": "string", "nullable": true, "description": "Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content." }, { "name": "displayName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display name." }, { "name": "placedPrice", "kind": "optional", "type": "number", "description": "Gets the price for one item that this line item represent. This property don't take any discounts in consideration.", "format": "double" }, { "name": "extendedPrice", "kind": "optional", "type": "number", "description": "

Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.

", "format": "double" }, { "name": "discountedPrice", "kind": "optional", "type": "number", "description": "

Gets the line item discounted price. Only calculates the price with the \"line item discount amount,\" that is, the discount for a specific item.

", "format": "double" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Gets or sets the number of items this line item contains.", "format": "double" }, { "name": "returnQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the returned in stock quantity.", "format": "double" }, { "name": "inventoryTrackingStatus", "kind": "optional", "type": "integer", "description": "", "modelRef": "#/components/schemas/InventoryTrackingStatus", "customType": "InventoryTrackingStatus", "schema": [] }, { "name": "isInventoryAllocated", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance has allocated inventory for the EPiServer.Commerce.Order.ILineItem.Quantity." }, { "name": "isGift", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether the line item is a gift item." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "payments", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/PaymentModel", "customType": "PaymentModel[]", "schema": [ { "name": "amount", "kind": "optional", "type": "number", "description": "", "format": "double" }, { "name": "authorizationCode", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "billingAddressId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "customerName", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "implementationClass", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "paymentId", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "paymentMethodId", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "paymentMethodName", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "paymentTypeModel", "kind": "optional", "type": "integer", "description": "", "modelRef": "#/components/schemas/PaymentTypeModel", "customType": "PaymentTypeModel", "schema": [] }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "transactionType", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "validationCode", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "transactionID", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "providerTransactionID", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Custom property item.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "discounts", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the discounts.", "modelRef": "#/components/schemas/DiscountModel", "customType": "DiscountModel[]", "schema": [ { "name": "discountId", "kind": "optional", "type": "integer", "description": "Gets or sets the discount id.", "format": "int32" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. Either fixed money value or percentage.", "format": "double" }, { "name": "discountCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the discount code. Also known as a coupon code." }, { "name": "discountName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the discount." }, { "name": "displayMessage", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display message." }, { "name": "discountValue", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount\r\nif it is a fixed monetary value. For the percentage based discount this value will be different.", "format": "double" } ] }, { "name": "returnComment", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the rma comment." }, { "name": "returnType", "kind": "optional", "type": "string", "nullable": true, "description": "

Gets or sets the Return Type. For example can be \"Refund\", \"Exchange\" etc.

" }, { "name": "returnAuthCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the RMA auth code. Using for procedure RMA authentications." }, { "name": "orderFormId", "kind": "optional", "type": "integer", "description": "Gets the order form id.", "format": "int32" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "billingAddressId", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the billing address id. The id is the name of the address in OrderAddress collection." }, { "name": "shippingTotal", "kind": "optional", "type": "number", "description": "

Gets or sets the shipping total, does not includes discounts that have been applied to each shipment.

", "format": "double" }, { "name": "handlingTotal", "kind": "optional", "type": "number", "description": "Gets or sets the handling total.", "format": "double" }, { "name": "taxTotal", "kind": "optional", "type": "number", "description": "Gets or sets the tax total.", "format": "double" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. This amount includes shipping discounts as well.", "format": "double" }, { "name": "subTotal", "kind": "optional", "type": "number", "description": "Gets or sets the sub total.", "format": "double" }, { "name": "total", "kind": "optional", "type": "number", "description": "Gets or sets the total.", "format": "double" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the status." }, { "name": "rmaNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the RMA number." }, { "name": "authorizedPaymentTotal", "kind": "optional", "type": "number", "description": "Gets or sets the authorized payment total.", "format": "double" }, { "name": "capturedPaymentTotal", "kind": "optional", "type": "number", "description": "Gets or sets the captured payment total.", "format": "double" }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "orderGroupId", "kind": "optional", "type": "integer", "description": "Order group ID.", "format": "int32" }, { "name": "orderNotes", "kind": "optional", "type": "array", "nullable": true, "description": "List of order notes.", "modelRef": "#/components/schemas/OrderNoteModel", "customType": "OrderNoteModel[]", "schema": [ { "name": "orderNoteId", "kind": "optional", "type": "integer", "nullable": true, "description": "Gets the order note ID.", "format": "int32" }, { "name": "created", "kind": "optional", "type": "string", "description": "Gets Created date.", "format": "date-time" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "Gets or sets note customer ID.", "format": "uuid" }, { "name": "detail", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets note details." }, { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets note title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets note type." }, { "name": "lineItemId", "kind": "optional", "type": "integer", "nullable": true, "description": "Gets or sets note related line item ID.", "format": "int32" } ] }, { "name": "owner", "kind": "optional", "type": "string", "nullable": true, "description": "Owner name." }, { "name": "ownerOrg", "kind": "optional", "type": "string", "nullable": true, "description": "Owner's organization name." }, { "name": "providerId", "kind": "optional", "type": "string", "nullable": true, "description": "Provider ID." }, { "name": "shippingTotal", "kind": "optional", "type": "number", "description": "Shipping total.", "format": "double" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "

Status.\r\nValid values:

\n
    \n
  • AwaitingExchange
    • \n
  • Cancelled
    • \n
  • Completed
    • \n
  • InProgress
    • \n
  • OnHold
    • \n
  • PartiallyShipped.
    • \n
" }, { "name": "subTotal", "kind": "optional", "type": "number", "description": "

Sub-total.

", "format": "double" }, { "name": "taxTotal", "kind": "optional", "type": "number", "description": "Tax total.", "format": "double" }, { "name": "total", "kind": "optional", "type": "number", "description": "Total.", "format": "double" }, { "name": "modified", "kind": "optional", "type": "string", "description": "Modified date.", "format": "date-time" }, { "name": "created", "kind": "optional", "type": "string", "description": "Created date.", "format": "date-time" }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] }, { "name": "orderNumber", "kind": "optional", "type": "string", "nullable": true, "description": "An order number used for tracking the order." }, { "name": "returnForms", "kind": "optional", "type": "array", "nullable": true, "description": "List of return order forms.", "modelRef": "#/components/schemas/ReturnOrderFormModel", "customType": "ReturnOrderFormModel[]", "schema": [ { "name": "shipments", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the shipments.", "modelRef": "#/components/schemas/ShipmentModel", "customType": "ShipmentModel[]", "schema": [ { "name": "discountsModel", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the discounts.", "modelRef": "#/components/schemas/DiscountModel", "customType": "DiscountModel[]", "schema": [ { "name": "discountId", "kind": "optional", "type": "integer", "description": "Gets or sets the discount id.", "format": "int32" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. Either fixed money value or percentage.", "format": "double" }, { "name": "discountCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the discount code. Also known as a coupon code." }, { "name": "discountName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the discount." }, { "name": "displayMessage", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display message." }, { "name": "discountValue", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount\r\nif it is a fixed monetary value. For the percentage based discount this value will be different.", "format": "double" } ] }, { "name": "shipmentId", "kind": "optional", "type": "integer", "description": "Gets the shipment id.", "format": "int32" }, { "name": "shippingMethodId", "kind": "optional", "type": "string", "description": "Gets or sets the shipping method id.", "format": "uuid" }, { "name": "shippingMethodName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the shipping method." }, { "name": "shippingTax", "kind": "optional", "type": "number", "description": "Gets or sets the shipment tax.", "format": "double" }, { "name": "shippingAddressId", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the shipping address name." }, { "name": "shipmentTrackingNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the shipment tracking number." }, { "name": "shippingDiscountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the shipping discount amount.", "format": "double" }, { "name": "shippingSubTotal", "kind": "optional", "type": "number", "description": "Gets or sets the shipping sub total.", "format": "double" }, { "name": "shippingTotal", "kind": "optional", "type": "number", "description": "

Gets or sets the total shipping cost, including shipping discounts (if any) and shipping tax.

", "format": "double" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the status." }, { "name": "prevStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the previous status." }, { "name": "pickListId", "kind": "optional", "type": "integer", "nullable": true, "description": "Gets or sets the pick list id.", "format": "int32" }, { "name": "subTotal", "kind": "optional", "type": "number", "description": "Gets or sets the sub total.", "format": "double" }, { "name": "warehouseCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the warehouse code." }, { "name": "lineItems", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the collection of line items.", "modelRef": "#/components/schemas/LineItemModel", "customType": "LineItemModel[]", "schema": [ { "name": "lineItemId", "kind": "optional", "type": "integer", "description": "Gets the identity of the line item.", "format": "int32" }, { "name": "code", "kind": "optional", "type": "string", "nullable": true, "description": "Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content." }, { "name": "displayName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display name." }, { "name": "placedPrice", "kind": "optional", "type": "number", "description": "Gets the price for one item that this line item represent. This property don't take any discounts in consideration.", "format": "double" }, { "name": "extendedPrice", "kind": "optional", "type": "number", "description": "

Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.

", "format": "double" }, { "name": "discountedPrice", "kind": "optional", "type": "number", "description": "

Gets the line item discounted price. Only calculates the price with the \"line item discount amount,\" that is, the discount for a specific item.

", "format": "double" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Gets or sets the number of items this line item contains.", "format": "double" }, { "name": "returnQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the returned in stock quantity.", "format": "double" }, { "name": "inventoryTrackingStatus", "kind": "optional", "type": "integer", "description": "", "modelRef": "#/components/schemas/InventoryTrackingStatus", "customType": "InventoryTrackingStatus", "schema": [] }, { "name": "isInventoryAllocated", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance has allocated inventory for the EPiServer.Commerce.Order.ILineItem.Quantity." }, { "name": "isGift", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether the line item is a gift item." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "lineItems", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the line items.", "modelRef": "#/components/schemas/LineItemModel", "customType": "LineItemModel[]", "schema": [ { "name": "lineItemId", "kind": "optional", "type": "integer", "description": "Gets the identity of the line item.", "format": "int32" }, { "name": "code", "kind": "optional", "type": "string", "nullable": true, "description": "Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content." }, { "name": "displayName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display name." }, { "name": "placedPrice", "kind": "optional", "type": "number", "description": "Gets the price for one item that this line item represent. This property don't take any discounts in consideration.", "format": "double" }, { "name": "extendedPrice", "kind": "optional", "type": "number", "description": "

Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.

", "format": "double" }, { "name": "discountedPrice", "kind": "optional", "type": "number", "description": "

Gets the line item discounted price. Only calculates the price with the \"line item discount amount,\" that is, the discount for a specific item.

", "format": "double" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Gets or sets the number of items this line item contains.", "format": "double" }, { "name": "returnQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the returned in stock quantity.", "format": "double" }, { "name": "inventoryTrackingStatus", "kind": "optional", "type": "integer", "description": "", "modelRef": "#/components/schemas/InventoryTrackingStatus", "customType": "InventoryTrackingStatus", "schema": [] }, { "name": "isInventoryAllocated", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance has allocated inventory for the EPiServer.Commerce.Order.ILineItem.Quantity." }, { "name": "isGift", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether the line item is a gift item." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "payments", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/PaymentModel", "customType": "PaymentModel[]", "schema": [ { "name": "amount", "kind": "optional", "type": "number", "description": "", "format": "double" }, { "name": "authorizationCode", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "billingAddressId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "customerName", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "implementationClass", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "paymentId", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "paymentMethodId", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "paymentMethodName", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "paymentTypeModel", "kind": "optional", "type": "integer", "description": "", "modelRef": "#/components/schemas/PaymentTypeModel", "customType": "PaymentTypeModel", "schema": [] }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "transactionType", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "validationCode", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "transactionID", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "providerTransactionID", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Custom property item.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] } ] }, { "name": "discounts", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the discounts.", "modelRef": "#/components/schemas/DiscountModel", "customType": "DiscountModel[]", "schema": [ { "name": "discountId", "kind": "optional", "type": "integer", "description": "Gets or sets the discount id.", "format": "int32" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. Either fixed money value or percentage.", "format": "double" }, { "name": "discountCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the discount code. Also known as a coupon code." }, { "name": "discountName", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name of the discount." }, { "name": "displayMessage", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the display message." }, { "name": "discountValue", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount\r\nif it is a fixed monetary value. For the percentage based discount this value will be different.", "format": "double" } ] }, { "name": "returnComment", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the rma comment." }, { "name": "returnType", "kind": "optional", "type": "string", "nullable": true, "description": "

Gets or sets the Return Type. For example can be \"Refund\", \"Exchange\" etc.

" }, { "name": "returnAuthCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the RMA auth code. Using for procedure RMA authentications." }, { "name": "orderFormId", "kind": "optional", "type": "integer", "description": "Gets the order form id.", "format": "int32" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "billingAddressId", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the billing address id. The id is the name of the address in OrderAddress collection." }, { "name": "shippingTotal", "kind": "optional", "type": "number", "description": "

Gets or sets the shipping total, does not includes discounts that have been applied to each shipment.

", "format": "double" }, { "name": "handlingTotal", "kind": "optional", "type": "number", "description": "Gets or sets the handling total.", "format": "double" }, { "name": "taxTotal", "kind": "optional", "type": "number", "description": "Gets or sets the tax total.", "format": "double" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Gets or sets the discount amount. This amount includes shipping discounts as well.", "format": "double" }, { "name": "subTotal", "kind": "optional", "type": "number", "description": "Gets or sets the sub total.", "format": "double" }, { "name": "total", "kind": "optional", "type": "number", "description": "Gets or sets the total.", "format": "double" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the status." }, { "name": "rmaNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the RMA number." }, { "name": "authorizedPaymentTotal", "kind": "optional", "type": "number", "description": "Gets or sets the authorized payment total.", "format": "double" }, { "name": "capturedPaymentTotal", "kind": "optional", "type": "number", "description": "Gets or sets the captured payment total.", "format": "double" }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets the list of key value pairs for dealing with custom properties.", "modelRef": "#/components/schemas/PropertyItemModel", "customType": "PropertyItemModel[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "nullable": true, "description": "Key of the property." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Value of the property." } ] }, { "name": "originalOrderFormId", "kind": "optional", "type": "integer", "nullable": true, "description": "Gets the Parent OrderForm identity for RMA request", "format": "int32" }, { "name": "exchangeOrderGroupId", "kind": "optional", "type": "integer", "nullable": true, "description": "Gets or sets the related this RMA request Exchange order identity", "format": "int32" } ] } ], "modelRef": "#/components/schemas/PurchaseOrderModel", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true }, { "statusCode": "204", "description": "The order is saved.", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "If the purchase order model is not valid.", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "If user does not have enough permission for this request.", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "If order does not exist.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "f2_dNe6H-ZxFpJxiqVAGc", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url /episerverapi/commerce/orders/{orderGroupId} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"name\": \"\"\n }'" }, { "id": "pZKErXg8g42SMzagXYenm", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"name\": \"\"\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"/episerverapi/commerce/orders/{orderGroupId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "q_D5wQEKXavWOqx4G16Y2", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/episerverapi/commerce/orders/{orderGroupId}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"name\": \"\"\n})\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "RyA6m8T-Q3LgFsLWmXql_", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/episerverapi/commerce/orders/{orderGroupId}\"\n\npayload = json.dumps({\n \"name\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "f2_dNe6H-ZxFpJxiqVAGc" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Success\n" }, { "id": "response-1-204", "language": "204", "code": "// The order is saved.\n" }, { "id": "response-2-400", "language": "400", "code": "// If the purchase order model is not valid.\n" }, { "id": "response-3-401", "language": "401", "code": "// If user does not have enough permission for this request.\n" }, { "id": "response-4-404", "language": "404", "code": "// If order does not exist.\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }