Skip to main content
POST
/
commerce
/
settings
/
fulfillment
/
fulfillmentsettings
Error
A valid request URL is required to generate request examples
{
  "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Body

application/json
actionOnBOPISReject
string | null
auditInfo
object
bpmConfiguration
object
configurableShipmentRelease
object
createShipmentsOnPendingReview
object
defaultBackOrderDays
integer<int32> | null
deliveryConsolidation
object
fulfillerSettings
object
fulfillmentJobSettings
object
futureDateLimit
object
futureInventoryEnabled
boolean | null
paymentVoidAndReauth
boolean | null
retainFlatRatePerOrder
boolean | null
shipToHomeConsolidation
object
shipToStore
object
shipmentsOnHold
object
substitution
object

Response

Success

actionOnBOPISReject
string | null
auditInfo
object
bpmConfiguration
object
configurableShipmentRelease
object
createShipmentsOnPendingReview
object
defaultBackOrderDays
integer<int32> | null
deliveryConsolidation
object
fulfillerSettings
object
fulfillmentJobSettings
object
futureDateLimit
object
futureInventoryEnabled
boolean | null
paymentVoidAndReauth
boolean | null
retainFlatRatePerOrder
boolean | null
shipToHomeConsolidation
object
shipToStore
object
shipmentsOnHold
object
substitution
object