Orders | Returns

Create a replacement order with all or some of the line items.

Sample request to create a replacement order for a single order line

POST /api/returns/CreateReplacementOrder
{
   "orderId": "EPIC000001",
   "orderLineReplacements": [
        {
            "lineItemId": "1",
            "quantity": 1,
            "replacementType": "Damaged",
            "replacementReason": "Replacement for damaged goods"
            "skuId": "product sku if you want to replace current item with another product"
        },
    ],
   "comment": "Replacement for damaged goods",
   "amountToCredit": "399.00",
}
post/api/Returns/CreateReplacementOrder

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Returns/CreateReplacementOrder
  • Auth: API key in header Authorization

Request body

orderIdstring required

Order id of the exsisting order to replace orderlines from.

commentstring nullable

Comment will be added to the replacement payment, and as a property on the replacement order.

amountToCreditnumber nullable

Optional: By default, a 'dummy' credit payment will be added to the original order, equal to the value of the replacement. This ensures the customer does not receive both the replacement and a full credit payment. In some cases, you may wish to issue a partial credit to the customer, for example, offering a 10% credit due to a delay or any other reason the replacement was necessary. In such scenarios, you should adjust this property's value to reflect the redced amount.

For instance, if the total amount for the replacement is 200 and you want to credit the customer 50, you should set this propery's value to 150.

Response

Success

returnIdstring nullable

Return ID

rmaNumberstring nullable

RMA (return merchandise authorization) number

returnCommentstring nullable

Return comment, used to describe reason for return

returnTypestring nullable

Return type

storeIdstring nullable

Store ID or warehouse where the product is returned

userIdstring nullable

User ID creating the return

statusstring nullable

Return status

modifiedstring date-time

Date modified

createdstring date-time

Date created

completedstring date-time nullable

Date the return was completed. Set by the SetCompletedDate return workflow step.

creditAmountnumber

Amount to credit

creditPaymentboolean

True if payment should be credited

replacementOrderIdsstring[] nullable

References to any replacement orders related to the return

sentNotificationIdsstring[] nullable

Notification IDs sent on this order

tagsstring[] nullable

Return tags (used by workflow filters and for grouping / filtering returns)

shippingDiscountTotalnumber

Calculated:Total shipping discounts

shippingSubTotalnumber

Calculated: Shipping cost without discounts

shippingSubTotalExclTaxnumber

Calculated: shipping cost without discounts excl tax

shippingCreditedTotalnumber

Calculated: Total shipping cost credited

cartNamestring nullable

Name of cart / offer, such as "A special offer for a special customer". This is typically used in scenarios where a customer is presented with an offer (in form of a cart).

cartIdstring nullable

Unique ID of cart

purchaseOrderIdstring nullable

Purchase order ID (if order was created from a purchase order)

couponCodesstring[] nullable

List of CouponCodes added by user

shippingTotalnumber

Calculated: Total shipping cost.

handlingTotalnumber

Cost of handling

orderLevelTaxnumber

Order level tax amount

taxTotalnumber

Calculated: Total tax amount (line item level and order level)

discountAmountnumber

Calculated: Total discount amount

subTotalnumber

Calculated: Order total without shipment cost

subTotalExclTaxnumber

Calculated: Order total without shipment cost and without tax

totalnumber

Calculated: Order total, including shipment cost, tax, and discounts

totalExclTaxnumber

Calculated: Order total, including shipment cost and discounts, but without tax

authorizedPaymentTotalnumber

Total amount authorized by payment providers

capturedPaymentTotalnumber

Total amount captured by payment providers

creditPaymentTotalnumber

Total amount credited by payment providers

fullRefundboolean

True if order should be fully refunded

isPriorityboolean nullable

Possible to mark the order with priority

grossRoundoffnumber nullable

Set by external systems. Is added to orderform.total.

Changes

No recorded changes to this operation across all 1 revision of this API.