handleOrderAmendment

post

/ccagent/v1/orderAmendments/{orderId}

Handle Order Amendment. Performs either of the operations initiateAmendment(initiates the order amendment process), checkAmendmentInProgress, priceOrderAmendmentcheck by passing op value. Additonally takes x-ccsite header to submit the edited order in a site. If the site information is not provided takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : handleOrderAmendment_request
Type: object
Show Source
Example:
{
    "op":"initiateAmendment",
    "continueWithInProgressEdit":false
}
Nested Schema : billingAddress
Type: object
Billing address for the order. Related Endpoint Operations - preAuthorizeAmendOrder
Show Source
Nested Schema : payments
Type: object
Payment in the cart. Related Endpoint Operations - preAuthorizeAmendOrder
Show Source
Nested Schema : shippingAddress
Type: object
shipping address for the order. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
Show Source
Nested Schema : shippingGroups
Type: array
List of shipping groups
Show Source
Nested Schema : shippingMethod
Type: object
Shipping method information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information. Related Endpoint Operations - priceOrderAmendment, preAuthorizeAmendOrder
Show Source
Nested Schema : customProperties
Type: object
Additional Properties Allowed
Show Source
Custom object with dynamic properties. This will be passed to the webhook request
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping method information.
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : discountInfo
Type: array
Discount Information.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : handleOrderAmendment_response
Type: object
Show Source
Nested Schema : cloneOrder
Type: object
The clone order details. Related Endpoint Operations - initiateAmendment
Show Source
Nested Schema : discountInfo
Type: object
Discount information. Related Endpoint Operations - priceOrderAmendment
Show Source
Nested Schema : orderableQuantityMap
Type: array
The list of all logged comments for the order. Related Endpoint Operations - initiateAmendment
Show Source
Nested Schema : paymentGroups
Type: array
List of payment Groups for the order. Related Endpoint Operations - preAuthorizeAmendOrder
Show Source
Nested Schema : payments
Type: object
Payment in the cart. Related Endpoint Operations - priceOrderAmendment
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order. Related Endpoint Operations - priceOrderAmendment
Show Source
Nested Schema : priceOverrideReasons
Type: array
All price override reasons. These are sent only if isItemPriceOverrideAllowed is true. Related Endpoint Operations - initiateAmendment
Show Source
Nested Schema : pricingMessages
Type: object
The Pricing messages information.
Show Source
Nested Schema : shippingGroups
Type: array
List of shipping groups
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information. Related Endpoint Operations - priceOrderAmendment
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order. Related Endpoint Operations - priceOrderAmendment
Show Source
Nested Schema : discountInfo
Type: object
Discount information.
Show Source