Get Fulfillment Settings

Retrieves existing fulfillment settings defined on the site

GET /commerce/settings/fulfillment/fulfillmentsettings

Error

A valid request URL is required to generate request examples

200

{
  "actionOnBOPISReject": "<string>",
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "bpmConfiguration": {
    "containerId": "<string>",
    "processId": "<string>"
  },
  "configurableShipmentRelease": {
    "b2BOrderRelease": {
      "automaticReleaseOffset": 123,
      "isEnabled": true,
      "releaseType": "<string>"
    },
    "isEnabled": true,
    "refreshPricingOnOrderEdit": true,
    "reserveInventoryOnOrderPendingShipment": true,
    "shipmentCreationOffset": 123
  },
  "createShipmentsOnPendingReview": {
    "isEnabled": true
  },
  "defaultBackOrderDays": 123,
  "deliveryConsolidation": {
    "allowPartialFulfillment": true,
    "cancellationOnParentShipment": true,
    "forceDeliveryConsolidation": true,
    "isEnabled": true,
    "multipleConsolidation": true,
    "restrictedCancellationSteps": [
      "<string>"
    ],
    "shippingMethodDeliveryConsolidation": {
      "code": "<string>",
      "name": "<string>"
    }
  },
  "fulfillerSettings": {
    "editShipment": true
  },
  "fulfillmentJobSettings": {
    "pickupReminderJob": {
      "interval": 123,
      "isEnabled": true
    },
    "releaseBackorderJob": {
      "interval": 123,
      "isEnabled": true,
      "partialReleaseEnabled": true,
      "partialReleaseType": "<string>"
    }
  },
  "futureDateLimit": {
    "futureDateLimitQuantity": 123,
    "futureDateLimitUnit": "<string>"
  },
  "futureInventoryEnabled": true,
  "paymentVoidAndReauth": true,
  "retainFlatRatePerOrder": true,
  "shipToHomeConsolidation": {
    "allowPartialFulfillment": true,
    "cancellationSTHC": {
      "onParentShipment": true,
      "restrictedSteps": [
        "<string>"
      ]
    },
    "forceSTHConsolidationOnSplitShipments": {
      "isEnabled": true
    },
    "isEnabled": true,
    "multipleConsolidation": {
      "isEnabled": true
    },
    "shippingMethodSTHC": {
      "code": "<string>",
      "name": "<string>"
    }
  },
  "shipToStore": {
    "alwaysCreateTransferShipments": true,
    "cancellation": {
      "onParentShipment": true,
      "restrictedSteps": [
        "<string>"
      ]
    },
    "isEnabled": true,
    "shippingMethod": {
      "code": "<string>",
      "name": "<string>"
    }
  },
  "shipmentsOnHold": {
    "autoRelease": {
      "enabled": true,
      "jobInterval": {
        "unit": "<string>",
        "value": 123
      }
    },
    "enabled": true,
    "manualRelease": true
  },
  "substitution": {
    "repriceOnSubstitution": true
  }
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

actionOnBOPISReject · string | null

auditInfo · object

Show child attributes

bpmConfiguration · object

Show child attributes

configurableShipmentRelease · object

Show child attributes

createShipmentsOnPendingReview · object

Show child attributes

defaultBackOrderDays · integer<int32> | null

deliveryConsolidation · object

Show child attributes

fulfillerSettings · object

Show child attributes

fulfillmentJobSettings · object

Show child attributes

futureDateLimit · object

Show child attributes

futureInventoryEnabled · boolean | null

paymentVoidAndReauth · boolean | null

retainFlatRatePerOrder · boolean | null

shipToHomeConsolidation · object

Show child attributes

shipToStore · object

Show child attributes

shipmentsOnHold · object

Show child attributes

substitution · object

Show child attributes