A valid request URL is required to generate request examples

{
  "id": "<string>",
  "externalShipmentId": "<string>",
  "number": 123,
  "orderId": "<string>",
  "orderNumber": 123,
  "email": "<string>",
  "currencyCode": "<string>",
  "customerAccountId": 123,
  "customerTaxId": "<string>",
  "shipmentType": "<string>",
  "shippingMethodCode": "<string>",
  "shippingMethodName": "<string>",
  "fulfillmentLocationCode": "<string>",
  "origin": {
    "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
    }
  },
  "destination": {
    "id": "<string>",
    "destinationContact": {
      "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
      }
    },
    "isDestinationCommercial": true,
    "data": {}
  },
  "shipmentStatus": "<string>",
  "shipmentStatusReason": {
    "reasonCode": "<string>",
    "moreInfo": "<string>"
  },
  "transferShipmentNumbers": [
    123
  ],
  "isTransfer": true,
  "originalShipmentNumber": 123,
  "parentCheckoutNumber": 123,
  "parentShipmentNumber": 123,
  "fulfillmentStatus": "<string>",
  "workflowProcessId": "<string>",
  "workflowProcessContainerId": "<string>",
  "workflowState": {
    "attributes": {},
    "auditInfo": {
      "updateDate": "2023-11-07T05:31:56Z",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "createBy": "<string>"
    },
    "completedDate": "2023-11-07T05:31:56Z",
    "processInstanceId": "<string>",
    "shipmentState": "<string>",
    "taskList": [
      {
        "links": {},
        "active": true,
        "attributes": {},
        "completed": true,
        "completedDate": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "inputs": [
          {
            "helpMessage": "<string>",
            "label": "<string>",
            "maxLength": 123,
            "maximum": 123,
            "minLength": 123,
            "minimum": 123,
            "name": "<string>",
            "options": [
              "<unknown>"
            ],
            "pattern": "<string>",
            "required": true,
            "type": "<string>"
          }
        ],
        "name": "<string>",
        "skippable": true,
        "subject": "<string>",
        "taskId": "<string>"
      }
    ]
  },
  "backorderCreatedDate": 123,
  "fulfillmentDate": "2023-11-07T05:31:56Z",
  "futureDate": "2023-11-07T05:31:56Z",
  "orderSubmitDate": "2023-11-07T05:31:56Z",
  "pickStatus": "<string>",
  "pickType": "<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": {}
    }
  ],
  "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": {}
    }
  ],
  "items": [
    {
      "lineId": 123,
      "originalOrderItemId": "<string>",
      "parentId": "<string>",
      "productCode": "<string>",
      "variationProductCode": "<string>",
      "optionAttributeFQN": "<string>",
      "name": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "fulfillmentLocationCode": "<string>",
      "imageUrl": "<string>",
      "isTaxable": true,
      "quantity": 123,
      "unitPrice": 123,
      "actualPrice": 123,
      "overridePrice": 123,
      "itemDiscount": 123,
      "lineItemCost": 123,
      "itemTax": 123,
      "shipping": 123,
      "shippingDiscount": 123,
      "shippingTax": 123,
      "handling": 123,
      "handlingDiscount": 123,
      "handlingTax": 123,
      "duty": 123,
      "isPackagedStandAlone": true,
      "readyForPickupQuantity": 123,
      "backorderReleaseDate": "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
        }
      },
      "options": [
        {
          "name": "<string>",
          "value": "<unknown>",
          "shopperEnteredValue": "<unknown>",
          "attributeFQN": "<string>",
          "dataType": "<string>",
          "stringValue": "<string>"
        }
      ],
      "data": {},
      "taxData": {},
      "weightedShipmentAdjustment": 123,
      "weightedLineItemTaxAdjustment": 123,
      "weightedShippingAdjustment": 123,
      "weightedShippingTaxAdjustment": 123,
      "weightedHandlingAdjustment": 123,
      "weightedHandlingTaxAdjustment": 123,
      "weightedDutyAdjustment": 123,
      "taxableShipping": 123,
      "taxableLineItemCost": 123,
      "taxableHandling": 123,
      "fulfillmentFields": [
        {
          "name": "<string>",
          "userEnteredValue": "<unknown>",
          "required": true
        }
      ],
      "isAssemblyRequired": true,
      "parentItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "giftCards": [
        {
          "activationDate": "2023-11-07T05:31:56Z",
          "cardNumber": "<string>",
          "code": "<string>",
          "creditType": "<string>",
          "creditValue": 123,
          "currencyCode": "<string>",
          "currentBalance": 123,
          "customerId": 123,
          "expirationDate": "2023-11-07T05:31:56Z",
          "initialBalance": 123
        }
      ],
      "locatorName": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "lineItemAdjustment": 123,
      "isReservedInventory": true,
      "cartItemId": "<string>",
      "sku": "<string>",
      "partNumber": "<string>",
      "upc": "<string>",
      "isSubstitutable": true,
      "originalLineId": 123,
      "originalQuantity": 123,
      "substituteQuantity": 123,
      "purchaseLocation": "<string>",
      "isGift": true,
      "giftMessage": "<string>",
      "priceMode": "<string>",
      "serialNumber": "<string>",
      "condition": "<string>",
      "substituteInfo": {
        "optIn": "<string>",
        "substituteProductCode": "<string>",
        "substituteVariantCode": "<string>"
      },
      "allowsSubstitution": true,
      "returnRuleInfo": {
        "isReturnable": true,
        "maxQty": 123,
        "maxDays": 123,
        "ruleCode": "<string>"
      },
      "substitutionType": "<string>",
      "bundleInfo": {
        "attributes": {},
        "imageUrl": "<string>",
        "name": "<string>",
        "productCode": "<string>",
        "quantity": 123,
        "unitPrice": 123
      },
      "expectedDeliveryDate": "2023-11-07T05:31:56Z"
    }
  ],
  "canceledItems": [
    {
      "lineId": 123,
      "originalOrderItemId": "<string>",
      "parentId": "<string>",
      "productCode": "<string>",
      "variationProductCode": "<string>",
      "optionAttributeFQN": "<string>",
      "name": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "fulfillmentLocationCode": "<string>",
      "imageUrl": "<string>",
      "isTaxable": true,
      "quantity": 123,
      "unitPrice": 123,
      "actualPrice": 123,
      "overridePrice": 123,
      "itemDiscount": 123,
      "lineItemCost": 123,
      "itemTax": 123,
      "shipping": 123,
      "shippingDiscount": 123,
      "shippingTax": 123,
      "handling": 123,
      "handlingDiscount": 123,
      "handlingTax": 123,
      "duty": 123,
      "isPackagedStandAlone": true,
      "readyForPickupQuantity": 123,
      "backorderReleaseDate": "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
        }
      },
      "options": [
        {
          "name": "<string>",
          "value": "<unknown>",
          "shopperEnteredValue": "<unknown>",
          "attributeFQN": "<string>",
          "dataType": "<string>",
          "stringValue": "<string>"
        }
      ],
      "data": {},
      "taxData": {},
      "weightedShipmentAdjustment": 123,
      "weightedLineItemTaxAdjustment": 123,
      "weightedShippingAdjustment": 123,
      "weightedShippingTaxAdjustment": 123,
      "weightedHandlingAdjustment": 123,
      "weightedHandlingTaxAdjustment": 123,
      "weightedDutyAdjustment": 123,
      "taxableShipping": 123,
      "taxableLineItemCost": 123,
      "taxableHandling": 123,
      "fulfillmentFields": [
        {
          "name": "<string>",
          "userEnteredValue": "<unknown>",
          "required": true
        }
      ],
      "isAssemblyRequired": true,
      "parentItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "giftCards": [
        {
          "activationDate": "2023-11-07T05:31:56Z",
          "cardNumber": "<string>",
          "code": "<string>",
          "creditType": "<string>",
          "creditValue": 123,
          "currencyCode": "<string>",
          "currentBalance": 123,
          "customerId": 123,
          "expirationDate": "2023-11-07T05:31:56Z",
          "initialBalance": 123
        }
      ],
      "locatorName": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "lineItemAdjustment": 123,
      "isReservedInventory": true,
      "cartItemId": "<string>",
      "sku": "<string>",
      "partNumber": "<string>",
      "upc": "<string>",
      "isSubstitutable": true,
      "originalLineId": 123,
      "originalQuantity": 123,
      "substituteQuantity": 123,
      "purchaseLocation": "<string>",
      "isGift": true,
      "giftMessage": "<string>",
      "priceMode": "<string>",
      "serialNumber": "<string>",
      "condition": "<string>",
      "substituteInfo": {
        "optIn": "<string>",
        "substituteProductCode": "<string>",
        "substituteVariantCode": "<string>"
      },
      "allowsSubstitution": true,
      "returnRuleInfo": {
        "isReturnable": true,
        "maxQty": 123,
        "maxDays": 123,
        "ruleCode": "<string>"
      },
      "substitutionType": "<string>",
      "bundleInfo": {
        "attributes": {},
        "imageUrl": "<string>",
        "name": "<string>",
        "productCode": "<string>",
        "quantity": 123,
        "unitPrice": 123
      },
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "canceledReason": {
        "reasonCode": "<string>",
        "description": "<string>",
        "moreInfo": "<string>"
      }
    }
  ],
  "data": {},
  "taxData": {},
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "shipmentAdjustment": 123,
  "lineItemSubtotal": 123,
  "lineItemTaxAdjustment": 123,
  "lineItemTaxTotal": 123,
  "lineItemTotal": 123,
  "shippingAdjustment": 123,
  "shippingSubtotal": 123,
  "shippingTaxAdjustment": 123,
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "handlingAdjustment": 123,
  "handlingSubtotal": 123,
  "handlingTaxAdjustment": 123,
  "handlingTaxTotal": 123,
  "handlingTotal": 123,
  "dutyAdjustment": 123,
  "dutyTotal": 123,
  "total": 123,
  "cost": 123,
  "externalOrderId": "<string>",
  "isExpress": true,
  "isFlatRateShipping": true,
  "readyToCapture": true,
  "pickupInfo": {},
  "shopperNotes": {
    "comments": "<string>",
    "deliveryInstructions": "<string>",
    "giftMessage": "<string>"
  },
  "customer": {
    "customerContact": {
      "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
      }
    },
    "data": "<unknown>",
    "isDestinationCommercial": true
  },
  "shipmentNotes": [
    {
      "attributes": {},
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "noteId": "<string>",
      "noteText": "<string>",
      "role": "<string>",
      "username": "<string>"
    }
  ],
  "alternateContact": {
    "firstName": "<string>",
    "lastNameOrSurname": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>"
  },
  "substitutedItems": [
    {
      "actualPrice": 123,
      "allocatedQuantity": 123,
      "allowsBackOrder": true,
      "allowsFutureAllocate": true,
      "allowsSubstitution": true,
      "appeasementReason": {
        "reasonCode": "<string>",
        "moreInfo": "<string>"
      },
      "attributes": {},
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "autoSubstitution": true,
      "backorderReleaseDate": "2023-11-07T05:31:56Z",
      "bundleInfo": {
        "attributes": {},
        "imageUrl": "<string>",
        "name": "<string>",
        "productCode": "<string>",
        "quantity": 123,
        "unitPrice": 123
      },
      "cartItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "condition": "<string>",
      "creditCurrencyCode": "<string>",
      "creditValue": 123,
      "data": {},
      "duty": 123,
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "fulfillmentFields": [
        {
          "name": "<string>",
          "required": true,
          "userEnteredValue": "<unknown>"
        }
      ],
      "giftCards": [
        {
          "activationDate": "2023-11-07T05:31:56Z",
          "cardNumber": "<string>",
          "code": "<string>",
          "creditType": "<string>",
          "creditValue": 123,
          "currencyCode": "<string>",
          "currentBalance": 123,
          "customerId": 123,
          "expirationDate": "2023-11-07T05:31:56Z",
          "initialBalance": 123
        }
      ],
      "giftMessage": "<string>",
      "goodsType": "<string>",
      "handling": 123,
      "handlingDiscount": 123,
      "handlingTax": 123,
      "height": 123,
      "imageUrl": "<string>",
      "inventoryAllocations": [
        {
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          },
          "condition": "<string>",
          "date": "2023-11-07T05:31:56Z",
          "fulfilledDate": "2023-11-07T05:31:56Z",
          "inventoryId": 123,
          "lotCode": "<string>",
          "originalQuantity": 123,
          "quantity": 123,
          "serialNumber": "<string>",
          "sku": "<string>",
          "status": "<string>"
        }
      ],
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isGift": true,
      "isPackagedStandAlone": true,
      "isReservedInventory": true,
      "isTaxable": true,
      "itemDiscount": 123,
      "itemTax": 123,
      "length": 123,
      "lineId": 123,
      "lineItemAdjustment": 123,
      "lineItemCost": 123,
      "locatorName": "<string>",
      "manageStock": true,
      "name": "<string>",
      "optionAttributeFQN": "<string>",
      "options": [
        {
          "attributeFQN": "<string>",
          "attributes": {},
          "dataType": "<string>",
          "name": "<string>",
          "shopperEnteredValue": "<unknown>",
          "stringValue": "<string>",
          "value": "<unknown>"
        }
      ],
      "originalLineId": 123,
      "originalOrderItemId": "<string>",
      "originalQuantity": 123,
      "overridePrice": 123,
      "parentItemId": "<string>",
      "partNumber": "<string>",
      "priceMode": "<string>",
      "productCode": "<string>",
      "purchaseLocation": "<string>",
      "quantity": 123,
      "readyForPickupQuantity": 123,
      "returnRuleInfo": {
        "attributes": {},
        "isReturnable": true,
        "maxDays": 123,
        "maxQty": 123,
        "ruleCode": "<string>"
      },
      "serialNumber": "<string>",
      "shipping": 123,
      "shippingDiscount": 123,
      "shippingTax": 123,
      "sku": "<string>",
      "substituteInfo": {
        "optIn": "<string>",
        "substituteProductCode": "<string>",
        "substituteVariantCode": "<string>"
      },
      "substituteItemLineIds": [
        123
      ],
      "substituteQuantity": 123,
      "substituteReason": {
        "reasonCode": "<string>",
        "moreInfo": "<string>"
      },
      "substitutionType": "<string>",
      "taxData": "<unknown>",
      "taxableHandling": 123,
      "taxableLineItemCost": 123,
      "taxableShipping": 123,
      "transferQuantity": 123,
      "trueTransferQuantity": 123,
      "unitPrice": 123,
      "upc": "<string>",
      "variationProductCode": "<string>",
      "weight": 123,
      "weightUnit": "<string>",
      "weightedDutyAdjustment": 123,
      "weightedHandlingAdjustment": 123,
      "weightedHandlingTaxAdjustment": 123,
      "weightedLineItemTaxAdjustment": 123,
      "weightedShipmentAdjustment": 123,
      "weightedShippingAdjustment": 123,
      "weightedShippingTaxAdjustment": 123,
      "width": 123
    }
  ],
  "expectedDeliveryDate": "2023-11-07T05:31:56Z",
  "holdReleaseDate": "2023-11-07T05:31:56Z"
}