Update Fulfillment Fields

Update a shipment’s fulfillment fields.

PUT /commerce/shipments/{shipmentNumber}/fulfillmentFields

Error

A valid request URL is required to generate request examples

200

{
  "orderId": "<string>",
  "orderNumber": 123,
  "shipmentType": "<string>",
  "total": 123,
  "_links": {
    "empty": true
  },
  "acceptedDate": "2023-11-07T05:31:56Z",
  "alternateContact": {
    "address": {
      "address1": "<string>",
      "address2": "<string>",
      "address3": "<string>",
      "address4": "<string>",
      "attributes": {},
      "cityOrTown": "<string>",
      "countryCode": "<string>",
      "isValidated": true,
      "latitude": "<string>",
      "longitude": "<string>",
      "postalOrZipCode": "<string>",
      "stateOrProvince": "<string>"
    },
    "attributes": {},
    "companyOrOrganization": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastNameOrSurname": "<string>",
    "middleNameOrInitial": "<string>",
    "phoneNumbers": {
      "attributes": {},
      "home": "<string>",
      "mobile": "<string>",
      "work": "<string>"
    },
    "shortFullName": "<string>"
  },
  "appeasementReason": {
    "moreInfo": "<string>",
    "reasonCode": "<string>"
  },
  "assignedLocationCode": "<string>",
  "attributes": {},
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "canceledItems": [
    {
      "handling": 123,
      "handlingTax": 123,
      "itemTax": 123,
      "lineId": 123,
      "quantity": 123,
      "shipping": 123,
      "shippingTax": 123,
      "actualPrice": 123,
      "allocatedQuantity": 123,
      "allowsBackOrder": true,
      "allowsFutureAllocate": true,
      "appeasementReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "attributes": {},
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "backorderReleaseDate": "2023-11-07T05:31:56Z",
      "blockAssignment": true,
      "canceledReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "cartItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "creditCurrencyCode": "<string>",
      "creditValue": 123,
      "data": {},
      "duty": 123,
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "fulfillmentFields": [
        {
          "name": "<string>",
          "required": true,
          "userEnteredValue": {}
        }
      ],
      "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
        }
      ],
      "handlingDiscount": 123,
      "imageUrl": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isPackagedStandAlone": true,
      "isReservedInventory": true,
      "isTaxable": true,
      "itemDiscount": 123,
      "lineItemAdjustment": 123,
      "lineItemCost": 123,
      "locatorName": "<string>",
      "manageStock": true,
      "name": "<string>",
      "optionAttributeFQN": "<string>",
      "options": [
        {
          "attributeFQN": "<string>",
          "attributes": {},
          "dataType": "<string>",
          "name": "<string>",
          "shopperEnteredValue": {},
          "stringValue": "<string>",
          "value": {}
        }
      ],
      "originalOrderItemId": "<string>",
      "originalQuantity": 123,
      "overridePrice": 123,
      "parentItemId": "<string>",
      "partNumber": "<string>",
      "productCode": "<string>",
      "readyForPickupQuantity": 123,
      "shippingDiscount": 123,
      "sku": "<string>",
      "taxData": {},
      "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
    }
  ],
  "cartId": "<string>",
  "changeMessages": [
    {
      "amount": 123,
      "appId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "appeasementReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "attributes": {},
      "changeMessageId": "<string>",
      "correlationId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "identifier": "<string>",
      "message": "<string>",
      "metadata": "<string>",
      "newValue": "<string>",
      "oldValue": "<string>",
      "subject": "<string>",
      "subjectType": "<string>",
      "success": true,
      "userDisplayName": "<string>",
      "userFirstName": "<string>",
      "userId": "<string>",
      "userLastName": "<string>",
      "verb": "<string>"
    }
  ],
  "childShipmentNumbers": [
    123
  ],
  "currencyCode": "<string>",
  "customer": {
    "customerContact": {
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "attributes": {},
        "cityOrTown": "<string>",
        "countryCode": "<string>",
        "isValidated": true,
        "latitude": "<string>",
        "longitude": "<string>",
        "postalOrZipCode": "<string>",
        "stateOrProvince": "<string>"
      },
      "attributes": {},
      "companyOrOrganization": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "fullName": "<string>",
      "id": 123,
      "lastNameOrSurname": "<string>",
      "middleNameOrInitial": "<string>",
      "phoneNumbers": {
        "attributes": {},
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      },
      "shortFullName": "<string>"
    },
    "data": {},
    "isDestinationCommercial": true
  },
  "customerAccountId": 123,
  "customerAddressId": 123,
  "customerTaxId": "<string>",
  "data": {},
  "destination": {
    "data": {},
    "destinationContact": {
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "attributes": {},
        "cityOrTown": "<string>",
        "countryCode": "<string>",
        "isValidated": true,
        "latitude": "<string>",
        "longitude": "<string>",
        "postalOrZipCode": "<string>",
        "stateOrProvince": "<string>"
      },
      "attributes": {},
      "companyOrOrganization": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "fullName": "<string>",
      "id": 123,
      "lastNameOrSurname": "<string>",
      "middleNameOrInitial": "<string>",
      "phoneNumbers": {
        "attributes": {},
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      },
      "shortFullName": "<string>"
    },
    "isDestinationCommercial": true,
    "locationCode": "<string>"
  },
  "dutyAdjustment": 123,
  "dutyTotal": 123,
  "email": "<string>",
  "externalOrderId": "<string>",
  "fulfillmentDate": "2023-11-07T05:31:56Z",
  "fulfillmentLocationCode": "<string>",
  "futureDate": "2023-11-07T05:31:56Z",
  "handlingAdjustment": 123,
  "handlingSubtotal": 123,
  "handlingTaxAdjustment": 123,
  "handlingTaxTotal": 123,
  "handlingTotal": 123,
  "isAutoAssigned": true,
  "isExpress": true,
  "isHistoricalImport": true,
  "isOptInForSms": true,
  "items": [
    {
      "handling": 123,
      "handlingTax": 123,
      "itemTax": 123,
      "lineId": 123,
      "quantity": 123,
      "shipping": 123,
      "shippingTax": 123,
      "actualPrice": 123,
      "allocatedQuantity": 123,
      "allowsBackOrder": true,
      "allowsFutureAllocate": true,
      "appeasementReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "attributes": {},
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "backorderReleaseDate": "2023-11-07T05:31:56Z",
      "cartItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "creditCurrencyCode": "<string>",
      "creditValue": 123,
      "data": {},
      "duty": 123,
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "fulfillmentFields": [
        {
          "name": "<string>",
          "required": true,
          "userEnteredValue": {}
        }
      ],
      "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
        }
      ],
      "handlingDiscount": 123,
      "imageUrl": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isPackagedStandAlone": true,
      "isReservedInventory": true,
      "isTaxable": true,
      "itemDiscount": 123,
      "lineItemAdjustment": 123,
      "lineItemCost": 123,
      "locatorName": "<string>",
      "manageStock": true,
      "name": "<string>",
      "optionAttributeFQN": "<string>",
      "options": [
        {
          "attributeFQN": "<string>",
          "attributes": {},
          "dataType": "<string>",
          "name": "<string>",
          "shopperEnteredValue": {},
          "stringValue": "<string>",
          "value": {}
        }
      ],
      "originalOrderItemId": "<string>",
      "overridePrice": 123,
      "parentItemId": "<string>",
      "partNumber": "<string>",
      "productCode": "<string>",
      "readyForPickupQuantity": 123,
      "shippingDiscount": 123,
      "sku": "<string>",
      "taxData": {},
      "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
    }
  ],
  "lineItemSubtotal": 123,
  "lineItemTaxAdjustment": 123,
  "lineItemTaxTotal": 123,
  "lineItemTotal": 123,
  "orderSubmitDate": "2023-11-07T05:31:56Z",
  "originalShipmentNumber": 123,
  "packages": [
    {
      "attributes": {},
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "carrier": "<string>",
      "fxcbDocumentsUrl": "<string>",
      "fxcbPackNotificationId": "<string>",
      "hasLabel": true,
      "integratorId": "<string>",
      "labelFormat": "<string>",
      "manifestId": "<string>",
      "measurements": {
        "attributes": {},
        "height": {
          "attributes": {},
          "unit": "<string>",
          "value": 123
        },
        "length": {
          "attributes": {},
          "unit": "<string>",
          "value": 123
        },
        "weight": {
          "attributes": {},
          "unit": "<string>",
          "value": 123
        },
        "width": {
          "attributes": {},
          "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>"
        }
      ],
      "shippingMethodCode": "<string>",
      "shippingMethodName": "<string>",
      "signatureRequired": true,
      "stringBarcode": "<string>",
      "trackingNumbers": [
        "<string>"
      ],
      "trackings": [
        {
          "attributes": {},
          "number": "<string>",
          "url": "<string>"
        }
      ]
    }
  ],
  "parentCheckoutNumber": 123,
  "parentShipmentNumber": 123,
  "pickWaveNumber": 123,
  "pickupInfo": {},
  "readyForPickup": true,
  "readyForPickupDate": "2023-11-07T05:31:56Z",
  "readyToCapture": true,
  "reassignedItems": [
    {
      "handling": 123,
      "handlingTax": 123,
      "itemTax": 123,
      "lineId": 123,
      "quantity": 123,
      "shipping": 123,
      "shippingTax": 123,
      "actualPrice": 123,
      "allocatedQuantity": 123,
      "allowsBackOrder": true,
      "allowsFutureAllocate": true,
      "appeasementReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "attributes": {},
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "backorderReleaseDate": "2023-11-07T05:31:56Z",
      "blockAssignment": false,
      "cartItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "creditCurrencyCode": "<string>",
      "creditValue": 123,
      "data": {},
      "duty": 123,
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "fulfillmentFields": [
        {
          "name": "<string>",
          "required": true,
          "userEnteredValue": {}
        }
      ],
      "fulfillmentLocationCode": "<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
        }
      ],
      "handlingDiscount": 123,
      "imageUrl": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isPackagedStandAlone": true,
      "isReservedInventory": true,
      "isTaxable": true,
      "itemDiscount": 123,
      "lineItemAdjustment": 123,
      "lineItemCost": 123,
      "locatorName": "<string>",
      "manageStock": true,
      "name": "<string>",
      "optionAttributeFQN": "<string>",
      "options": [
        {
          "attributeFQN": "<string>",
          "attributes": {},
          "dataType": "<string>",
          "name": "<string>",
          "shopperEnteredValue": {},
          "stringValue": "<string>",
          "value": {}
        }
      ],
      "originalOrderItemId": "<string>",
      "originalQuantity": 123,
      "overridePrice": 123,
      "parentItemId": "<string>",
      "partNumber": "<string>",
      "productCode": "<string>",
      "readyForPickupQuantity": 123,
      "reassignedReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "shippingDiscount": 123,
      "sku": "<string>",
      "taxData": {},
      "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
    }
  ],
  "receivedDate": "2023-11-07T05:31:56Z",
  "rejectedItems": [
    {
      "handling": 123,
      "handlingTax": 123,
      "itemTax": 123,
      "lineId": 123,
      "quantity": 123,
      "shipping": 123,
      "shippingTax": 123,
      "actualPrice": 123,
      "allocatedQuantity": 123,
      "allowsBackOrder": true,
      "allowsFutureAllocate": true,
      "appeasementReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "attributes": {},
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "backorderReleaseDate": "2023-11-07T05:31:56Z",
      "blockAssignment": false,
      "cartItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "creditCurrencyCode": "<string>",
      "creditValue": 123,
      "data": {},
      "duty": 123,
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "fulfillmentFields": [
        {
          "name": "<string>",
          "required": true,
          "userEnteredValue": {}
        }
      ],
      "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
        }
      ],
      "handlingDiscount": 123,
      "imageUrl": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isPackagedStandAlone": true,
      "isReservedInventory": true,
      "isTaxable": true,
      "itemDiscount": 123,
      "lineItemAdjustment": 123,
      "lineItemCost": 123,
      "locatorName": "<string>",
      "manageStock": true,
      "name": "<string>",
      "optionAttributeFQN": "<string>",
      "options": [
        {
          "attributeFQN": "<string>",
          "attributes": {},
          "dataType": "<string>",
          "name": "<string>",
          "shopperEnteredValue": {},
          "stringValue": "<string>",
          "value": {}
        }
      ],
      "originalOrderItemId": "<string>",
      "originalQuantity": 123,
      "overridePrice": 123,
      "parentItemId": "<string>",
      "partNumber": "<string>",
      "productCode": "<string>",
      "readyForPickupQuantity": 123,
      "rejectedReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "shippingDiscount": 123,
      "sku": "<string>",
      "taxData": {},
      "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
    }
  ],
  "sentCustomerAtStoreNotification": true,
  "sentCustomerInTransitNotification": true,
  "shipmentAdjustment": 123,
  "shipmentNotes": [
    {
      "attributes": {},
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "noteId": "<string>",
      "noteText": "<string>",
      "role": "<string>",
      "username": "<string>"
    }
  ],
  "shipmentNumber": 123,
  "shipmentStatusReason": {
    "moreInfo": "<string>",
    "reasonCode": "<string>"
  },
  "shippingAdjustment": 123,
  "shippingMethodCode": "<string>",
  "shippingMethodName": "<string>",
  "shippingSubtotal": 123,
  "shippingTaxAdjustment": 123,
  "shippingTaxTotal": 123,
  "shippingTotal": 123,
  "shopperNotes": {
    "comments": "<string>",
    "deliveryInstructions": "<string>",
    "giftMessage": "<string>"
  },
  "siteId": 123,
  "taxData": {},
  "tenantId": 123,
  "transferShipmentNumbers": [
    123
  ],
  "transferredItems": [
    {
      "handling": 123,
      "handlingTax": 123,
      "itemTax": 123,
      "lineId": 123,
      "quantity": 123,
      "shipping": 123,
      "shippingTax": 123,
      "actualPrice": 123,
      "allocatedQuantity": 123,
      "allowsBackOrder": true,
      "allowsFutureAllocate": true,
      "appeasementReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "attributes": {},
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "backorderReleaseDate": "2023-11-07T05:31:56Z",
      "blockAssignment": true,
      "cartItemId": "<string>",
      "childItemIds": [
        "<string>"
      ],
      "creditCurrencyCode": "<string>",
      "creditValue": 123,
      "data": {},
      "duty": 123,
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "fulfillmentFields": [
        {
          "name": "<string>",
          "required": true,
          "userEnteredValue": {}
        }
      ],
      "fulfillmentLocationCode": "<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
        }
      ],
      "handlingDiscount": 123,
      "imageUrl": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "isAssemblyRequired": true,
      "isPackagedStandAlone": true,
      "isReservedInventory": true,
      "isTaxable": true,
      "itemDiscount": 123,
      "lineItemAdjustment": 123,
      "lineItemCost": 123,
      "locatorName": "<string>",
      "manageStock": true,
      "name": "<string>",
      "optionAttributeFQN": "<string>",
      "options": [
        {
          "attributeFQN": "<string>",
          "attributes": {},
          "dataType": "<string>",
          "name": "<string>",
          "shopperEnteredValue": {},
          "stringValue": "<string>",
          "value": {}
        }
      ],
      "originalOrderItemId": "<string>",
      "originalQuantity": 123,
      "overridePrice": 123,
      "parentItemId": "<string>",
      "partNumber": "<string>",
      "productCode": "<string>",
      "readyForPickupQuantity": 123,
      "rejectedReason": {
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "shippingDiscount": 123,
      "sku": "<string>",
      "taxData": {},
      "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
    }
  ],
  "transitTime": "<string>",
  "userId": "<string>",
  "workflowProcessContainerId": "<string>",
  "workflowProcessId": "<string>",
  "workflowState": {
    "activeTaskName": "<string>",
    "attributes": {},
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "completedDate": "2023-11-07T05:31:56Z",
    "processInstanceId": "<string>",
    "shipmentState": "<string>",
    "taskList": [
      {
        "_links": {},
        "active": true,
        "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": [
              {}
            ],
            "pattern": "<string>",
            "required": true
          }
        ],
        "name": "<string>",
        "skippable": true,
        "subject": "<string>",
        "taskId": "<string>"
      }
    ],
    "variables": {}
  }
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Headers

If-Match · string

If-Match

Path Parameters

shipmentNumber · integer<int32> · required

shipmentNumber

Body

application/json

items

handling · number<bigdecimal> · required

handlingTax · number<bigdecimal> · required

itemTax · number<bigdecimal> · required

lineId · integer<int32> · required

quantity · integer<int32> · required

shipping · number<bigdecimal> · required

shippingTax · number<bigdecimal> · required

actualPrice · number<bigdecimal>

allocatedQuantity · integer<int32>

allowsBackOrder · boolean

allowsFutureAllocate · boolean

appeasementReason · AppeasementReason · object

Show child attributes

attributes · object

Show child attributes

auditInfo · AuditInfo0 · object

Show child attributes

backorderReleaseDate · string<date-time>

cartItemId · string

childItemIds · string[]

creditCurrencyCode · string

creditValue · number<bigdecimal>

data · object

Show child attributes

duty · number<bigdecimal>

expectedDeliveryDate · string<date-time>

fulfillmentFields · FulfillmentField · object[]

Show child attributes

giftCards · GiftCard · object[]

Show child attributes

goodsType · enum<string>

Available options: Digital, DigitalCredit, DigitalGiftCard, Physical, Service

handlingDiscount · number<bigdecimal>

imageUrl · string

inventoryTags · InventoryTag · object[]

Show child attributes

isAssemblyRequired · boolean

isPackagedStandAlone · boolean

isReservedInventory · boolean

isTaxable · boolean

itemDiscount · number<bigdecimal>

lineItemAdjustment · number<bigdecimal>

lineItemCost · number<bigdecimal>

locatorName · string

manageStock · boolean

name · string

optionAttributeFQN · string

options · ProductOption · object[]

Show child attributes

originalOrderItemId · string

overridePrice · number<bigdecimal>

parentItemId · string

partNumber · string

productCode · string

readyForPickupQuantity · integer<int32>

shippingDiscount · number<bigdecimal>

sku · string

taxData · object

taxableHandling · number<bigdecimal>

taxableLineItemCost · number<bigdecimal>

taxableShipping · number<bigdecimal>

transferQuantity · integer<int32>

trueTransferQuantity · integer<int32>

unitPrice · number<bigdecimal>

upc · string

variationProductCode · string

weight · number<bigdecimal>

weightUnit · string

weightedDutyAdjustment · number<bigdecimal>

weightedHandlingAdjustment · number<bigdecimal>

weightedHandlingTaxAdjustment · number<bigdecimal>

weightedLineItemTaxAdjustment · number<bigdecimal>

weightedShipmentAdjustment · number<bigdecimal>

weightedShippingAdjustment · number<bigdecimal>

weightedShippingTaxAdjustment · number<bigdecimal>

Response

200

application/hal+json

OK

orderId · string · required

orderNumber · integer<int32> · required

shipmentType · string · required

total · number<bigdecimal> · required

_links · Links · object

Show child attributes

acceptedDate · string<date-time>

alternateContact · Contact · object

Show child attributes

appeasementReason · AppeasementReason · object

Show child attributes

assignedLocationCode · string

attributes · object

Show child attributes

auditInfo · AuditInfo0 · object

Show child attributes

canceledItems · CanceledItem · object[]

Show child attributes

cartId · string

changeMessages · ChangeMessage · object[]

Show child attributes

childShipmentNumbers · integer<int32>[]

currencyCode · string

customer · Customer · object

Show child attributes

customerAccountId · integer<int32>

customerAddressId · integer<int32>

customerTaxId · string

data · object

Show child attributes

destination · Destination · object

Show child attributes

dutyAdjustment · number<bigdecimal>

dutyTotal · number<bigdecimal>

email · string

externalOrderId · string

fulfillmentDate · string<date-time>

fulfillmentLocationCode · string

fulfillmentStatus · enum<string>

Available options: NotFulfilled, Fulfilled

futureDate · string<date-time>

handlingAdjustment · number<bigdecimal>

handlingSubtotal · number<bigdecimal>

handlingTaxAdjustment · number<bigdecimal>

handlingTaxTotal · number<bigdecimal>

handlingTotal · number<bigdecimal>

isAutoAssigned · boolean

isExpress · boolean

isHistoricalImport · boolean

isOptInForSms · boolean

items · Item · object[]

Show child attributes

lineItemSubtotal · number<bigdecimal>

lineItemTaxAdjustment · number<bigdecimal>

lineItemTaxTotal · number<bigdecimal>

lineItemTotal · number<bigdecimal>

orderSubmitDate · string<date-time>

originalShipmentNumber · integer<int32>

packages · Package · object[]

Show child attributes

parentCheckoutNumber · integer<int32>

parentShipmentNumber · integer<int32>

pickStatus · enum<string>

Available options: AVAILABLE, IN_WAVE, PICKED, TRANSFER, COMPLETE

pickType · enum<string>

Available options: NORMAL, SINGLE, MULTIPLE

pickWaveNumber · integer<int32>

pickupInfo · object

Show child attributes

readyForPickup · boolean

readyForPickupDate · string<date-time>

readyToCapture · boolean

reassignedItems · ReassignedItem · object[]

Show child attributes

receivedDate · string<date-time>

rejectedItems · RejectedItem · object[]

Show child attributes

sentCustomerAtStoreNotification · boolean

sentCustomerInTransitNotification · boolean

shipmentAdjustment · number<bigdecimal>

shipmentNotes · ShipmentNote · object[]

Show child attributes

shipmentNumber · integer<int32>

shipmentStatus · enum<string>

Available options: READY, REASSIGNED, BACKORDER, CANCELED, FULFILLED, CUSTOMER_CARE, DELETED, FUTURE

shipmentStatusReason · ShipmentStatusReason · object

Show child attributes

shippingAdjustment · number<bigdecimal>

shippingMethodCode · string

shippingMethodName · string

shippingSubtotal · number<bigdecimal>

shippingTaxAdjustment · number<bigdecimal>

shippingTaxTotal · number<bigdecimal>

shippingTotal · number<bigdecimal>

shopperNotes · ShopperNotes · object

Show child attributes

siteId · integer<int32>

taxData · object

tenantId · integer<int32>

transferShipmentNumbers · integer<int32>[]

transferredItems · TransferredItem · object[]

Show child attributes

transitTime · string

userId · string

workflowProcessContainerId · string

workflowProcessId · string

workflowState · WorkflowState · object

Show child attributes