Create Return
To create a return for a customer's order that has already been fulfilled and completed, you will need to call the /createReturn endpoint with the POST method.
Request
Endpoint
POST:
https://{host}/api/createReturn
Header
Content-Type: application/json
Body
In the request body, include the information necessary for creating a return, including all the parameters listed below:
Parameter Name | Description |
externalId | Order identification in the external system (e.g. Shopify or Netsuite) |
customerId | Customer’s Identification in HotWax Commerce (partyId) |
companyId | Identification for the Company owning the brand |
currencyCode | Currency unit of measurement (USD, INR, YEN, etc.) |
facilityId | Facility where order is returned |
idType | Identification Type |
orderId | Unique HotWax Commerce Order Identification |
items | List of Order Items |
orderName | Shopify Order Name |
orderItemSeqId | Order Item Sequence |
status | Current status of the return |
grandTotal | Sum total of return items |
returnIdentificationTypeId | Global Identification for the return (“SHOPIFY_RTN_ID”) |
IdValue (in returnIdentification) | Unique Value for return identification |
idType | Global Identification Type (SKU, INVOICE_EXPORT, ISBN, UPCA, UPCE) |
idValue | Unique Id value for the global identification |
shipFrom | Customer's address |
shipTo | Destination address for returned order |
sku | SKU for returned item |
id (in item list) | Product id for that item |
price | Price of the individual item |
quantity | Product Quantity |
orderItemExternalId (in item list) | Order Item id for external system (Shopify or Netsuite) |
itemAdjustments | Record of adjustments (taxes or discounts) applied on the particular item |
type | Type of return adjustments |
returnAdjustments | Record of adjustments applied on the return |
Types of Return Adjustments:
Return adjustments are used to categorize different return-level charges. By storing all adjustments as types of adjustments that can be applied to the return, instead of including them in the return header, they can be extended based on the needs of custom implementations and integrations.
| Return Adjustment Type | Description |
|---|---|
RET_ADD_FEATURE_ADJ | Return Additional Feature |
RET_DEPOSIT_ADJ | Return Deposit Adjustment |
RET_DISCOUNT_ADJ | Return Discount |
RET_DUTY_ADJ | RMA Duty |
RET_EXT_PRM_ADJ | Return External Promotion Adjustment |
RET_FEE_ADJ | Return Fee |
RET_MAN_ADJ | Return Manual Adjustment |
RET_MISC_ADJ | Return Miscellaneous Charges |
RET_MKTG_PKG_ADJ | Return Marketing Package Adjustment |
RET_PROMOTION_ADJ | Return Promotion |
RET_REPLACE_ADJ | Return Replacement |
RET_RMA_ADJ | RMA Fee Adjustment |
RET_SALES_TAX_ADJ | Return Sales Tax |
RET_SHIPPING_ADJ | Return S&H |
RET_SURCHARGE_ADJ | Return Surcharge |
RET_VAT_PC_ADJ | Return VAT Price Correction |
RET_VAT_TAX_ADJ | Return VAT Tax |
RET_WARRANTY_ADJ | Return Warranty |
Response
Header
Content-Type: application/json
Body
The response will include all the parameters provided in the request body, along with any error messages and login information.
Last updated