Error
A valid request URL is required to generate request examples{
"items": [
{
"actionRequired": true,
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"canInitiateRefund": true,
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"channelCode": "<string>",
"contact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "jsmith@example.com",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"currencyCode": "<string>",
"customerAccountId": 123,
"customerInteractionType": "<string>",
"data": {},
"externalId": "<string>",
"id": "<string>",
"isUnified": true,
"items": [
{
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"bundledProducts": [
{
"productCode": "<string>",
"quantity": 123
}
],
"data": {},
"dispositionInfo": [
{
"condition": "<string>",
"locationCode": "<string>",
"quantity": 123,
"status": "<string>"
}
],
"excludeProductExtras": true,
"id": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}
],
"orderItemId": "<string>",
"orderItemOptionAttributeFQN": "<string>",
"orderLineId": 123,
"product": {
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"bundledProducts": [
{
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"creditValue": 123,
"deltaPrice": 123,
"description": "<string>",
"fulfillmentStatus": "<string>",
"goodsType": "<string>",
"imageUrl": "<string>",
"isPackagedStandAlone": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"productCode": "<string>",
"productReservationId": 123,
"quantity": 123,
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
}
}
],
"categories": [
{
"id": 123,
"parent": {}
}
],
"condition": "<string>",
"description": "<string>",
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": null
}
],
"fulfillmentStatus": "<string>",
"fulfillmentTypesSupported": [
"<string>"
],
"goodsType": "<string>",
"imageAlternateText": "<string>",
"imageUrl": "<string>",
"isPackagedStandAlone": true,
"isRecurring": true,
"isTaxable": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"mfgPartNumber": "<string>",
"name": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"price": {
"creditValue": 123,
"isOverRidePriceSalePrice": true,
"msrp": 123,
"price": 123,
"priceListCode": "<string>",
"priceListEntryMode": "<string>",
"salePrice": 123,
"tenantOverridePrice": 123
},
"productCode": "<string>",
"productReservationId": 123,
"productType": "<string>",
"productUsage": "<string>",
"properties": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"isMultiValue": true,
"name": "<string>",
"values": [
{
"stringValue": "<string>",
"value": null
}
]
}
],
"serialNumber": "<string>",
"sku": "<string>",
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
},
"upc": "<string>",
"variationProductCode": "<string>"
},
"productLossAmount": 123,
"productLossTaxAmount": 123,
"quantityReceived": 123,
"quantityRefunded": 123,
"quantityReplaced": 123,
"quantityRestockable": 123,
"quantityRestocked": 123,
"quantityShipped": 123,
"reasons": [
{
"quantity": 123,
"reason": "<string>"
}
],
"receiveStatus": "<string>",
"refundAmount": 123,
"refundStatus": "<string>",
"replaceStatus": "<string>",
"returnNotRequired": true,
"returnProcessingFeeApplied": 123,
"returnType": "<string>",
"shipmentItemId": 123,
"shipmentNumber": 123,
"shippingAndHandlingRefunded": true,
"shippingLossAmount": 123,
"shippingLossTaxAmount": 123,
"taxData": {},
"totalWithWeightedShippingAndHandling": 123,
"totalWithoutWeightedShippingAndHandling": 123
}
],
"locationCode": "<string>",
"lossTotal": 123,
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}
],
"originalOrderId": "<string>",
"originalOrderNumber": 123,
"overrideReturnRule": true,
"packages": [
{
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"carrier": "<string>",
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"code": "<string>",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"fxcbDocumentsUrl": "<string>",
"fxcbPackNotificationId": "<string>",
"hasLabel": true,
"id": "<string>",
"integratorId": "<string>",
"items": [
{
"fulfillmentItemType": "<string>",
"lineId": 123,
"optionAttributeFQN": "<string>",
"productCode": "<string>",
"quantity": 123
}
],
"labelFormat": "<string>",
"manifestId": "<string>",
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"packageId": "<string>",
"packagingType": "<string>",
"packingSlipItemDetails": [
{
"attributes": {},
"lineId": 123,
"originalOrderItemId": "<string>",
"quantity": 123
}
],
"packingSlipNumber": 123,
"returnCarrier": "<string>",
"returnTrackingNumbers": [
"<string>"
],
"returnTrackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"shipmentId": "<string>",
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"signatureRequired": true,
"status": "<string>",
"trackingNumber": "<string>",
"trackingNumbers": [
"<string>"
],
"trackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
]
}
],
"payments": [
{
"amountCollected": 123,
"amountCredited": 123,
"amountRequested": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"billingInfo": {
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"billingContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "jsmith@example.com",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"card": {
"bin": "<string>",
"cardNumberPartOrMask": "<string>",
"ccLastFour": "<string>",
"expireMonth": 123,
"expireYear": 123,
"isCardInfoSaved": true,
"isTokenized": true,
"isUsedRecurring": true,
"nameOnCard": "<string>",
"paymentOrCardType": "<string>",
"paymentServiceCardId": "<string>"
},
"check": {
"checkNumber": "<string>"
},
"customCreditType": "<string>",
"data": {},
"externalTransactionId": "<string>",
"isRecurring": true,
"isSameBillingShippingAddress": true,
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"purchaseOrder": {
"customFields": [
{
"code": "<string>",
"label": "<string>",
"value": "<string>"
}
],
"paymentTerm": {
"code": "<string>",
"description": "<string>"
},
"purchaseOrderNumber": "<string>"
},
"recurringTransactionId": "<string>",
"storeCreditCode": "<string>",
"storeCreditType": "<string>",
"token": {
"paymentServiceTokenId": "<string>",
"type": "<string>"
}
},
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"data": {},
"externalTransactionId": "<string>",
"gatewayGiftCard": {
"amount": 123,
"cardNumber": "<string>",
"cardPin": "<string>",
"currencyCode": "<string>",
"id": "<string>"
},
"groupId": {
"targetId": "<string>",
"targetNumber": 123,
"targetType": "<string>"
},
"id": "<string>",
"installmentPlanCode": "<string>",
"interactions": [
{
"amount": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"capturableShipmentsSummary": [
{
"amountApplied": 123,
"shipmentNumber": 123,
"shipmentTotal": 123
}
],
"checkNumber": "<string>",
"currencyCode": "<string>",
"gatewayAVSCodes": "<string>",
"gatewayAuthCode": "<string>",
"gatewayCVV2Codes": "<string>",
"gatewayInteractionId": 123,
"gatewayResponseCode": "<string>",
"gatewayResponseData": [
{
"key": "<string>",
"value": "<string>"
}
],
"gatewayResponseText": "<string>",
"gatewayTransactionId": "<string>",
"id": "<string>",
"interactionDate": "2023-11-07T05:31:56Z",
"interactionType": "<string>",
"isManual": true,
"isPending": true,
"isRecurring": true,
"note": "<string>",
"orderId": "<string>",
"paymentEntryStatus": "<string>",
"paymentId": "<string>",
"paymentTransactionInteractionIdReference": 123,
"refundId": "<string>",
"returnId": "<string>",
"status": "<string>",
"target": {
"targetId": "<string>",
"targetNumber": 123,
"targetType": "<string>"
}
}
],
"isRecurring": true,
"orderId": "<string>",
"paymentServiceTransactionId": "<string>",
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"status": "<string>",
"subPayments": [
{
"amountCollected": 123,
"amountCredited": 123,
"amountRefunded": 123,
"amountRequested": 123,
"status": "<string>",
"target": {
"targetId": "<string>",
"targetNumber": 123,
"targetType": "<string>"
}
}
]
}
],
"pickupDate": "2023-11-07T05:31:56Z",
"productLossTaxTotal": 123,
"productLossTotal": 123,
"receiveStatus": "<string>",
"refundAmount": 123,
"refundStatus": "<string>",
"refundToGC": true,
"replaceStatus": "<string>",
"returnNumber": 123,
"returnOrderId": "<string>",
"returnType": "<string>",
"rmaDeadline": "2023-11-07T05:31:56Z",
"shipOrBillCountryCode": "<string>",
"shipOrBillState": "<string>",
"shippingLossTaxTotal": 123,
"shippingLossTotal": 123,
"siteId": 123,
"status": "<string>",
"taxData": {},
"tenantId": 123,
"userId": "<string>",
"visitId": "<string>",
"webSessionId": "<string>"
}
],
"pageCount": 123,
"pageSize": 123,
"startIndex": 123,
"totalCount": 123
}Perform Return Action
Performs a specified action on one or more returns.
POST
/
commerce
/
returns
/
actions
Error
A valid request URL is required to generate request examples{
"items": [
{
"actionRequired": true,
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"canInitiateRefund": true,
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"channelCode": "<string>",
"contact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "jsmith@example.com",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"currencyCode": "<string>",
"customerAccountId": 123,
"customerInteractionType": "<string>",
"data": {},
"externalId": "<string>",
"id": "<string>",
"isUnified": true,
"items": [
{
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"bundledProducts": [
{
"productCode": "<string>",
"quantity": 123
}
],
"data": {},
"dispositionInfo": [
{
"condition": "<string>",
"locationCode": "<string>",
"quantity": 123,
"status": "<string>"
}
],
"excludeProductExtras": true,
"id": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}
],
"orderItemId": "<string>",
"orderItemOptionAttributeFQN": "<string>",
"orderLineId": 123,
"product": {
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"bundledProducts": [
{
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"creditValue": 123,
"deltaPrice": 123,
"description": "<string>",
"fulfillmentStatus": "<string>",
"goodsType": "<string>",
"imageUrl": "<string>",
"isPackagedStandAlone": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"productCode": "<string>",
"productReservationId": 123,
"quantity": 123,
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
}
}
],
"categories": [
{
"id": 123,
"parent": {}
}
],
"condition": "<string>",
"description": "<string>",
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
"fulfillmentFields": [
{
"name": "<string>",
"required": true,
"userEnteredValue": null
}
],
"fulfillmentStatus": "<string>",
"fulfillmentTypesSupported": [
"<string>"
],
"goodsType": "<string>",
"imageAlternateText": "<string>",
"imageUrl": "<string>",
"isPackagedStandAlone": true,
"isRecurring": true,
"isTaxable": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"mfgPartNumber": "<string>",
"name": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"price": {
"creditValue": 123,
"isOverRidePriceSalePrice": true,
"msrp": 123,
"price": 123,
"priceListCode": "<string>",
"priceListEntryMode": "<string>",
"salePrice": 123,
"tenantOverridePrice": 123
},
"productCode": "<string>",
"productReservationId": 123,
"productType": "<string>",
"productUsage": "<string>",
"properties": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"isMultiValue": true,
"name": "<string>",
"values": [
{
"stringValue": "<string>",
"value": null
}
]
}
],
"serialNumber": "<string>",
"sku": "<string>",
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
},
"upc": "<string>",
"variationProductCode": "<string>"
},
"productLossAmount": 123,
"productLossTaxAmount": 123,
"quantityReceived": 123,
"quantityRefunded": 123,
"quantityReplaced": 123,
"quantityRestockable": 123,
"quantityRestocked": 123,
"quantityShipped": 123,
"reasons": [
{
"quantity": 123,
"reason": "<string>"
}
],
"receiveStatus": "<string>",
"refundAmount": 123,
"refundStatus": "<string>",
"replaceStatus": "<string>",
"returnNotRequired": true,
"returnProcessingFeeApplied": 123,
"returnType": "<string>",
"shipmentItemId": 123,
"shipmentNumber": 123,
"shippingAndHandlingRefunded": true,
"shippingLossAmount": 123,
"shippingLossTaxAmount": 123,
"taxData": {},
"totalWithWeightedShippingAndHandling": 123,
"totalWithoutWeightedShippingAndHandling": 123
}
],
"locationCode": "<string>",
"lossTotal": 123,
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}
],
"originalOrderId": "<string>",
"originalOrderNumber": 123,
"overrideReturnRule": true,
"packages": [
{
"attributes": {},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"carrier": "<string>",
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"code": "<string>",
"fulfillmentDate": "2023-11-07T05:31:56Z",
"fulfillmentLocationCode": "<string>",
"fxcbDocumentsUrl": "<string>",
"fxcbPackNotificationId": "<string>",
"hasLabel": true,
"id": "<string>",
"integratorId": "<string>",
"items": [
{
"fulfillmentItemType": "<string>",
"lineId": 123,
"optionAttributeFQN": "<string>",
"productCode": "<string>",
"quantity": 123
}
],
"labelFormat": "<string>",
"manifestId": "<string>",
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"packageId": "<string>",
"packagingType": "<string>",
"packingSlipItemDetails": [
{
"attributes": {},
"lineId": 123,
"originalOrderItemId": "<string>",
"quantity": 123
}
],
"packingSlipNumber": 123,
"returnCarrier": "<string>",
"returnTrackingNumbers": [
"<string>"
],
"returnTrackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
],
"shipmentId": "<string>",
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"signatureRequired": true,
"status": "<string>",
"trackingNumber": "<string>",
"trackingNumbers": [
"<string>"
],
"trackings": [
{
"attributes": {},
"number": "<string>",
"url": "<string>"
}
]
}
],
"payments": [
{
"amountCollected": 123,
"amountCredited": 123,
"amountRequested": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"billingInfo": {
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"billingContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "jsmith@example.com",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"card": {
"bin": "<string>",
"cardNumberPartOrMask": "<string>",
"ccLastFour": "<string>",
"expireMonth": 123,
"expireYear": 123,
"isCardInfoSaved": true,
"isTokenized": true,
"isUsedRecurring": true,
"nameOnCard": "<string>",
"paymentOrCardType": "<string>",
"paymentServiceCardId": "<string>"
},
"check": {
"checkNumber": "<string>"
},
"customCreditType": "<string>",
"data": {},
"externalTransactionId": "<string>",
"isRecurring": true,
"isSameBillingShippingAddress": true,
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"purchaseOrder": {
"customFields": [
{
"code": "<string>",
"label": "<string>",
"value": "<string>"
}
],
"paymentTerm": {
"code": "<string>",
"description": "<string>"
},
"purchaseOrderNumber": "<string>"
},
"recurringTransactionId": "<string>",
"storeCreditCode": "<string>",
"storeCreditType": "<string>",
"token": {
"paymentServiceTokenId": "<string>",
"type": "<string>"
}
},
"changeMessages": [
{
"amount": 123,
"appId": "<string>",
"appKey": "<string>",
"appName": "<string>",
"attributes": {},
"correlationId": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"message": "<string>",
"metadata": "<unknown>",
"newValue": "<string>",
"oldValue": "<string>",
"subject": "<string>",
"subjectType": "<string>",
"success": true,
"userFirstName": "<string>",
"userId": "<string>",
"userLastName": "<string>",
"userScopeType": "<string>",
"verb": "<string>"
}
],
"data": {},
"externalTransactionId": "<string>",
"gatewayGiftCard": {
"amount": 123,
"cardNumber": "<string>",
"cardPin": "<string>",
"currencyCode": "<string>",
"id": "<string>"
},
"groupId": {
"targetId": "<string>",
"targetNumber": 123,
"targetType": "<string>"
},
"id": "<string>",
"installmentPlanCode": "<string>",
"interactions": [
{
"amount": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"capturableShipmentsSummary": [
{
"amountApplied": 123,
"shipmentNumber": 123,
"shipmentTotal": 123
}
],
"checkNumber": "<string>",
"currencyCode": "<string>",
"gatewayAVSCodes": "<string>",
"gatewayAuthCode": "<string>",
"gatewayCVV2Codes": "<string>",
"gatewayInteractionId": 123,
"gatewayResponseCode": "<string>",
"gatewayResponseData": [
{
"key": "<string>",
"value": "<string>"
}
],
"gatewayResponseText": "<string>",
"gatewayTransactionId": "<string>",
"id": "<string>",
"interactionDate": "2023-11-07T05:31:56Z",
"interactionType": "<string>",
"isManual": true,
"isPending": true,
"isRecurring": true,
"note": "<string>",
"orderId": "<string>",
"paymentEntryStatus": "<string>",
"paymentId": "<string>",
"paymentTransactionInteractionIdReference": 123,
"refundId": "<string>",
"returnId": "<string>",
"status": "<string>",
"target": {
"targetId": "<string>",
"targetNumber": 123,
"targetType": "<string>"
}
}
],
"isRecurring": true,
"orderId": "<string>",
"paymentServiceTransactionId": "<string>",
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"status": "<string>",
"subPayments": [
{
"amountCollected": 123,
"amountCredited": 123,
"amountRefunded": 123,
"amountRequested": 123,
"status": "<string>",
"target": {
"targetId": "<string>",
"targetNumber": 123,
"targetType": "<string>"
}
}
]
}
],
"pickupDate": "2023-11-07T05:31:56Z",
"productLossTaxTotal": 123,
"productLossTotal": 123,
"receiveStatus": "<string>",
"refundAmount": 123,
"refundStatus": "<string>",
"refundToGC": true,
"replaceStatus": "<string>",
"returnNumber": 123,
"returnOrderId": "<string>",
"returnType": "<string>",
"rmaDeadline": "2023-11-07T05:31:56Z",
"shipOrBillCountryCode": "<string>",
"shipOrBillState": "<string>",
"shippingLossTaxTotal": 123,
"shippingLossTotal": 123,
"siteId": 123,
"status": "<string>",
"taxData": {},
"tenantId": 123,
"userId": "<string>",
"visitId": "<string>",
"webSessionId": "<string>"
}
],
"pageCount": 123,
"pageSize": 123,
"startIndex": 123,
"totalCount": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
application/json
A ReturnAction instance that takes the name of the action to be performed and a list of Return Ids upon which to perform the action.
⌘I