A valid request URL is required to generate request examples

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