By default, shipments are created immediately upon order submission which means you must make edits to order items and pricing at the shipment level. However, you can change this behavior to delay shipment creation and inventory allocation to a preset time after submission.
This allows you to reduce the rate of item returns and cancellations after shipments are already fulfilled or in the process of being fulfilled, as well as the ability to edit the order between submission and shipment creation.
When you have configured shipment creation to a later date, future inventory and reservations will still be supported by those shipments. However, there are some special behaviors defined in this guide.
Configure Shipment Creation
The site settings determine when to create the shipment and allocate inventory after order submission. If not configured, shipments will be created immediately.
Before you can configure shipment creation, you need to submit a Kibo Support request to enable the feature on your tenant. Once enabled:
- Go to System > Settings > General > Site > Fulfillment Settings.
- Toggle Enable configurable shipment release.
- Enter a value for Create shipments _ minutes after order submit. This can be any number between 1-7200.
- If desired, enable Reserve inventory when order status is PendingShipment. If enabled, inventory will be reserved when the order is submitted. If disabled, then inventory will be reserved upon shipment creation.
- Click Save in the top right.
Pending Shipments Status
When this feature is enabled, orders will be put into the Pending Shipments status upon submission. The Order Confirmation email will be triggered at this time, if enabled. During this status, you will also be able to make edits at the order level such as changing item quantity, pricing, and adding new items. Once shipments are created, the order will move out of Pending Shipments and any further edits must be made at the shipment level instead.
However, this is only supported for orders with a single shipping address. If multi ship is enabled on your tenant, then any orders with more than one shipping address will not be editable. You must wait until shipments are created and then make your edits at the shipment level.
See the Edit Order and Edit Order Items documentation for more information about making updates at both the order and shipment levels.
If an order is in Pending Review status and is accepted, then the system will first look at the shipment creation date of the order. If the date has passed, then the system will release the order and create the shipments. If the date has not yet passed, then the order will not be released from fraud until that date is reached.
Inventory Reservations
There is some special behavior to be aware of when using inventory reservations. If you opted to reserve inventory on the Pending Shipment status:
- Inventory will automatically be reserved when the order is submitted. If any items were already reserved in the cart, then that reservation will carry over to the order and any additional items will be added to the existing reservation.
- If you do not reserve any inventory in the cart, then a new reservation will be created for the order and those items will be reserved while waiting for the shipment(s) to be created.
- If any edits are made to the order items, such as changing quantity, then the system will check whether the Reserve Inventory when order status is pending shipment setting is enabled and whether the changed item is part of the existing reservation. If either of these are true, the reservation will be updated.
If you opted to not reserve inventory on the Pending Shipment status, but you do reserve inventory in the cart:
- The cart reservation will still carry over to the order and be reserved upon shipment creation (which is the default behavior without the Pending Shipment setting enabled) but any additional unreserved items will not be added to the existing reservation.
- If new item(s) are added to the order, the system will check whether to add them to the reservation or not based on the Reserve Inventory when order status is pending shipment setting. If this setting is enabled, then the new item(s) will be added to the existing reservation.
API Override
You can override the shipment creation site setting for a particular order via the Create Order API and Update Order API. This is useful in cases such as if your shipments are set to be delayed for one day but you know you won't be able to fulfill them for another two days. In that case, you can delay the shipment creation by an extra day either upon order creation or after the order has been created.
This top-level field is called shipmentCreationOffset in the API request, as found in the below example. The value determines the amount of minutes that shipment creation is delayed by, and can be -1 or any number between 1 and 7200. If -1, then the shipment delay will be bypassed and shipments will be immediately created without sending the order into the Pending Shipment status.
"shipmentCreationOffset": 1440,
"version": "1",
"isPartialOrder": false,
"availableActions": [
"ValidateOrder",
"SetOrderAsProcessing",
"CancelOrder"
],
"customerAccountId": 1000,
"isTaxExempt": false,
"email": "Admin@kibocommerce.com",
"ipAddress": "172.16.254.150",
"type": "Offline",
"paymentStatus": "Unpaid",
"returnStatus": "None",
"isEligibleForReturns": false,
"totalCollected": 0,
"attributes": [],
"shippingDiscounts": [],
"handlingDiscounts": [],
"handlingTotal": 0,
"fulfillmentStatus": "NotFulfilled",
"isFulfillable": false,
"submittedDate": "2023-02-24T11:51:09.690Z",
"releaseShipmentDate": "2023-02-23T21:31:09.690Z",
"acceptedDate": "2023-02-24T12:04:45.253Z",
"notes": [],
"items": [
{
"id": "194d203d2e784268ac05afb300c33ed8",
"fulfillmentLocationCode": "Loc1",
"fulfillmentMethod": "Ship",
"isReservationEnabled": false,
"lineId": 1,
"product": {
"mfgPartNumber": "SP_01",
"sku": "SP_01",
"fulfillmentTypesSupported": [
"DirectShip",
"InStorePickup"
],
"options": [],
"properties": [],
"categories": [],
"price": {
"price": 10
},
"discountsRestricted": false,
"isTaxable": true,
"productType": "standard",
"productUsage": "Standard",
"bundledProducts": [],
"productCode": "SP_01",
"name": "SP_01",
"goodsType": "Physical",
"isPackagedStandAlone": false,
"stock": {
"manageStock": true,
"isOnBackOrder": false,
"stockAvailable": 75,
"aggregateInventory": 0,
"isSubstitutable": false
},
"measurements": {
"height": {
"unit": "in",
"value": 1
},
"width": {
"unit": "in",
"value": 1
},
"length": {
"unit": "in",
"value": 1
},
"weight": {
"unit": "lbs",
"value": 1
}
},
"fulfillmentStatus": "PendingFulfillment"
},
"quantity": 1,
"subtotal": 10,
"extendedTotal": 10,
"taxableTotal": 10,
"discountTotal": 0,
"discountedTotal": 10,
"itemTaxTotal": 0,
"shippingTaxTotal": 0,
"shippingTotal": 0,
"feeTotal": 0,
"total": 10,
"unitPrice": {
"extendedAmount": 10,
"listAmount": 10
},
"productDiscounts": [],
"shippingDiscounts": [],
"auditInfo": {
"updateDate": "2023-02-24T11:50:52.057Z",
"createDate": "2023-02-24T11:50:52.057Z",
"updateBy": "355060a60a5e48eeb7f2fb8d92af2ba5",
"createBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
},
"shippingAmountBeforeDiscountsAndAdjustments": 0,
"weightedOrderAdjustment": 0,
"weightedOrderDiscount": 0,
"adjustedLineItemSubtotal": 10,
"totalWithoutWeightedShippingAndHandling": 10,
"weightedOrderTax": 0,
"weightedOrderShipping": 15,
"weightedOrderShippingDiscount": 0,
"weightedOrderShippingManualAdjustment": 0,
"weightedOrderShippingTax": 0,
"weightedOrderHandlingFee": 0,
"weightedOrderHandlingFeeTax": 0,
"weightedOrderHandlingFeeDiscount": 0,
"weightedOrderDuty": 0,
"totalWithWeightedShippingAndHandling": 25,
"weightedOrderHandlingAdjustment": 0,
"isAssemblyRequired": false
}
],
"validationResults": [],
"billingInfo": {
"billingContact": {
"id": 1000,
"email": "Admin@kibocommerce.com",
"firstName": "anagha",
"lastNameOrSurname": "deshmukh",
"phoneNumbers": {
"home": "5129991111"
},
"address": {
"address1": "State Capital, Suite 1173",
"cityOrTown": "Sacramento",
"stateOrProvince": "CA",
"postalOrZipCode": "95814",
"countryCode": "US",
"addressType": "Residential",
"isValidated": false
}
},
"isSameBillingShippingAddress": false,
"auditInfo": {
"updateDate": "2023-02-24T11:50:42.192Z",
"createDate": "2023-02-24T11:50:42.192Z",
"updateBy": "355060a60a5e48eeb7f2fb8d92af2ba5",
"createBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
},
"isRecurring": false
},
"payments": [],
"refunds": [],
"credits": [],
"packages": [],
"pickups": [],
"digitalPackages": [],
"isDraft": false,
"hasDraft": false,
"isImport": false,
"isHistoricalImport": false,
"isUnified": true,
"couponCodes": [],
"invalidCoupons": [],
"amountAvailableForRefund": 0,
"amountRemainingForPayment": 25,
"amountRefunded": 0,
"readyToCapture": false,
"isOptInForSms": false,
"continuityOrderOrdinal": 0,
"userId": "2406bfcddf3e4f5d94a2b1626f3f8cfd",
"id": "14f9028614d09a0001bbaedc00004856",
"tenantId": 18518,
"siteId": 23414,
"channelCode": "test",
"currencyCode": "USD",
"customerInteractionType": "Unknown",
"fulfillmentInfo": {
"fulfillmentContact": {
"id": 1000,
"email": "Admin@kibocommerce.com",
"firstName": "anagha",
"lastNameOrSurname": "deshmukh",
"phoneNumbers": {
"home": "5129991111"
},
"address": {
"address1": "State Capital, Suite 1173",
"cityOrTown": "Sacramento",
"stateOrProvince": "CA",
"postalOrZipCode": "95814",
"countryCode": "US",
"addressType": "Residential",
"isValidated": false
}
},
"shippingMethodCode": "b9742c08b30749c487f7afaf0129a8fd",
"shippingMethodName": "Flat Rate",
"auditInfo": {
"updateDate": "2023-02-24T11:51:01.084Z",
"createDate": "2023-02-24T11:50:29.667Z",
"updateBy": "355060a60a5e48eeb7f2fb8d92af2ba5",
"createBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
}
},
"orderDiscounts": [],
"suggestedDiscounts": [],
"subtotal": 10,
"discountedSubtotal": 10,
"discountTotal": 0,
"discountedTotal": 10,
"shippingTotal": 15,
"shippingSubTotal": 15,
"shippingTaxTotal": 0,
"handlingTaxTotal": 0,
"itemTaxTotal": 0,
"taxTotal": 0,
"feeTotal": 0,
"total": 25,
"lineItemSubtotalWithOrderAdjustments": 10,
"shippingAmountBeforeDiscountsAndAdjustments": 15,
"lastValidationDate": "2023-02-24T11:50:53.798Z",
"changeMessages": [
{
"id": "9092b52fbece4c6d8c68afb300c3256e",
"correlationId": "ac4b3ab78b5c498a8cc01864b5556620",
"userId": "355060a60a5e48eeb7f2fb8d92af2ba5",
"userFirstName": "Kibo",
"userLastName": "admin",
"userScopeType": "Tenant",
"appId": "2e778ae20c7c433885c8e5e418774cb4",
"appKey": "mozu.MozuAdmin.2302.2.0.Release",
"subjectType": "StateChange.WorkflowAction",
"success": true,
"identifier": "14f9028614d09a0001bbaedc00004856",
"subject": "CreateOrder",
"verb": "Applied",
"message": "Workflow action succeeded.",
"metadata": [
{
"oldValue": "Null",
"newValue": "Pending"
}
],
"oldValue": "Null",
"newValue": "Pending",
"createDate": "2023-02-24T11:50:30.337Z"
},
{
"id": "55fa337c3ed04bad94a3afb300c32f6d",
"correlationId": "56ee2068ab1c44d38ee5e0d9e8eda00d",
"userId": "355060a60a5e48eeb7f2fb8d92af2ba5",
"userFirstName": "Kibo",
"userLastName": "admin",
"userScopeType": "Tenant",
"appId": "2e778ae20c7c433885c8e5e418774cb4",
"appKey": "mozu.MozuAdmin.2302.2.0.Release",
"subjectType": "Order",
"identifier": "14f9028614d09a0001bbaedc00004856",
"subject": "Fulfillment Info Updated",
"verb": "Updated",
"message": "Fulfillment Info Updated",
"metadata": [
{
"updatedFulfillment": {
"FulfillmentContact": {
"Id": 1000,
"Email": "Admin@kibocommerce.com",
"FirstName": "anagha",
"LastNameOrSurname": "deshmukh",
"PhoneNumbers": {
"Home": "5129991111"
},
"Address": {
"Address1": "State Capital, Suite 1173",
"Address2": null,
"Address3": null,
"Address4": null,
"CityOrTown": "Sacramento",
"StateOrProvince": "CA",
"PostalOrZipCode": "95814",
"CountryCode": "US",
"AddressType": "Residential",
"IsValidated": false
}
},
"ShippingMethodCode": null,
"ShippingMethodName": null,
"IsDestinationCommercial": null,
"Data": null,
"AuditInfo": {
"UpdateDate": "2023-02-24T11:50:38.8594175Z",
"CreateDate": "2023-02-24T11:50:29.667Z",
"UpdateBy": "355060a60a5e48eeb7f2fb8d92af2ba5",
"CreateBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
}
},
"originalFulfillment": {
"FulfillmentContact": null,
"ShippingMethodCode": null,
"ShippingMethodName": null,
"IsDestinationCommercial": null,
"Data": null,
"AuditInfo": {
"UpdateDate": "2023-02-24T11:50:29.667Z",
"CreateDate": "2023-02-24T11:50:29.667Z",
"UpdateBy": "355060a60a5e48eeb7f2fb8d92af2ba5",
"CreateBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
}
}
}
],
"createDate": "2023-02-24T11:50:38.868Z"
},
{
"id": "1852516b6c064521974dafb300c332a2",
"correlationId": "fec3bcd49cab4d588b5c86f5f735806d",
"userId": "355060a60a5e48eeb7f2fb8d92af2ba5",
"userFirstName": "Kibo",
"userLastName": "admin",
"userScopeType": "Tenant",
"appId": "2e778ae20c7c433885c8e5e418774cb4",
"appKey": "mozu.MozuAdmin.2302.2.0.Release",
"subjectType": "Order",
"identifier": "14f9028614d09a0001bbaedc00004856",
"subject": "Fulfillment Info Updated",
"verb": "Updated",
"message": "Fulfillment Info Updated",
"metadata": [
{
"updatedFulfillment": {
"FulfillmentContact": {
"Id": 1000,
"Email": "Admin@kibocommerce.com",
"FirstName": "anagha",
"LastNameOrSurname": "deshmukh",
"PhoneNumbers": {
"Home": "5129991111"
},
"Address": {
"Address1": "State Capital, Suite 1173",
"Address2": null,
"Address3": null,
"Address4": null,
"CityOrTown": "Sacramento",
"StateOrProvince": "CA",
"PostalOrZipCode": "95814",
"CountryCode": "US",
"AddressType": "Residential",
"IsValidated": false
}
},
"ShippingMethodCode": null,
"ShippingMethodName": null,
"IsDestinationCommercial": null,
"Data": null,
"AuditInfo": {
"UpdateDate": "2023-02-24T11:50:41.589849Z",
"CreateDate": "2023-02-24T11:50:29.667Z",
"UpdateBy": "355060a60a5e48eeb7f2fb8d92af2ba5",
"CreateBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
}
},
"originalFulfillment": {
"FulfillmentContact": {
"Id": 1000,
"Email": "Admin@kibocommerce.com",
"FirstName": "anagha",
"LastNameOrSurname": "deshmukh",
"PhoneNumbers": {
"Home": "5129991111"
},
"Address": {
"Address1": "State Capital, Suite 1173",
"Address2": null,
"Address3": null,
"Address4": null,
"CityOrTown": "Sacramento",
"StateOrProvince": "CA",
"PostalOrZipCode": "95814",
"CountryCode": "US",
"AddressType": "Residential",
"IsValidated": false
}
},
"ShippingMethodCode": null,
"ShippingMethodName": null,
"IsDestinationCommercial": null,
"Data": null,
"AuditInfo": {
"UpdateDate": "2023-02-24T11:50:38.859Z",
"CreateDate": "2023-02-24T11:50:29.667Z",
"UpdateBy": "355060a60a5e48eeb7f2fb8d92af2ba5",
"CreateBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
}
}
}
],
"createDate": "2023-02-24T11:50:41.603Z"
},
{
"id": "beca8f9710f14b3ba237afb300c33fcf",
"correlationId": "f87d4450f1c242f9949ceacc1933270c",
"userId": "355060a60a5e48eeb7f2fb8d92af2ba5",
"userFirstName": "Kibo",
"userLastName": "admin",
"userScopeType": "Tenant",
"appId": "2e778ae20c7c433885c8e5e418774cb4",
"appKey": "mozu.MozuAdmin.2302.2.0.Release",
"subjectType": "OrderItem",
"identifier": "194d203d2e784268ac05afb300c33ed8",
"subject": "Item Added",
"verb": "Added",
"message": "Product SP_01 (Code: SP_01) was added.",
"metadata": [
{
"productCode": "SP_01",
"productName": "SP_01",
"quantity": 1
}
],
"createDate": "2023-02-24T11:50:52.848Z"
},
{
"id": "98f41af1c579410fb71dafb300c34976",
"correlationId": "778581b6a3be482e87077ededa60b542",
"userId": "355060a60a5e48eeb7f2fb8d92af2ba5",
"userFirstName": "Kibo",
"userLastName": "admin",
"userScopeType": "Tenant",
"appId": "2e778ae20c7c433885c8e5e418774cb4",
"appKey": "mozu.MozuAdmin.2302.2.0.Release",
"subjectType": "Order",
"identifier": "14f9028614d09a0001bbaedc00004856",
"subject": "Fulfillment Info Updated",
"verb": "Updated",
"message": "Fulfillment Info Updated",
"metadata": [
{
"updatedFulfillment": {
"FulfillmentContact": {
"Id": 1000,
"Email": "Admin@kibocommerce.com",
"FirstName": "anagha",
"LastNameOrSurname": "deshmukh",
"PhoneNumbers": {
"Home": "5129991111"
},
"Address": {
"Address1": "State Capital, Suite 1173",
"Address2": null,
"Address3": null,
"Address4": null,
"CityOrTown": "Sacramento",
"StateOrProvince": "CA",
"PostalOrZipCode": "95814",
"CountryCode": "US",
"AddressType": "Residential",
"IsValidated": false
}
},
"ShippingMethodCode": "b9742c08b30749c487f7afaf0129a8fd",
"ShippingMethodName": "Flat Rate",
"IsDestinationCommercial": null,
"Data": null,
"AuditInfo": {
"UpdateDate": "2023-02-24T11:51:01.0845537Z",
"CreateDate": "2023-02-24T11:50:29.667Z",
"UpdateBy": "355060a60a5e48eeb7f2fb8d92af2ba5",
"CreateBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
}
},
"originalFulfillment": {
"FulfillmentContact": {
"Id": 1000,
"Email": "Admin@kibocommerce.com",
"FirstName": "anagha",
"LastNameOrSurname": "deshmukh",
"PhoneNumbers": {
"Home": "5129991111"
},
"Address": {
"Address1": "State Capital, Suite 1173",
"Address2": null,
"Address3": null,
"Address4": null,
"CityOrTown": "Sacramento",
"StateOrProvince": "CA",
"PostalOrZipCode": "95814",
"CountryCode": "US",
"AddressType": "Residential",
"IsValidated": false
}
},
"ShippingMethodCode": null,
"ShippingMethodName": null,
"IsDestinationCommercial": null,
"Data": null,
"AuditInfo": {
"UpdateDate": "2023-02-24T11:50:41.589Z",
"CreateDate": "2023-02-24T11:50:29.667Z",
"UpdateBy": "355060a60a5e48eeb7f2fb8d92af2ba5",
"CreateBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
}
}
}
],
"createDate": "2023-02-24T11:51:01.085Z"
},
{
"id": "813fa05e2b3149c5a234afb300c353ad",
"correlationId": "273fda8718ff4027b77654207a76e034",
"userId": "355060a60a5e48eeb7f2fb8d92af2ba5",
"userFirstName": "Kibo",
"userLastName": "admin",
"userScopeType": "Tenant",
"appId": "2e778ae20c7c433885c8e5e418774cb4",
"appKey": "mozu.MozuAdmin.2302.2.0.Release",
"subjectType": "StateChange.WorkflowAction",
"success": true,
"identifier": "14f9028614d09a0001bbaedc00004856",
"subject": "SubmitOrder",
"verb": "Applied",
"message": "Workflow action succeeded.",
"metadata": [
{
"oldValue": "Pending",
"newValue": "Submitted"
}
],
"oldValue": "Pending",
"newValue": "Submitted",
"createDate": "2023-02-24T11:51:09.800Z"
},
{
"id": "c5e7a806bacb411da871afb300c358f1",
"correlationId": "",
"subjectType": "StateChange.WorkflowAction",
"success": true,
"identifier": "14f9028614d09a0001bbaedc00004856",
"subject": "ValidateOrder",
"verb": "Applied",
"message": "Workflow action succeeded.",
"metadata": [
{
"oldValue": "Submitted",
"newValue": "Validated"
}
],
"oldValue": "Submitted",
"newValue": "Validated",
"createDate": "2023-02-24T11:51:14.293Z"
},
{
"id": "123a79a60d3e413eb514afb300c35907",
"correlationId": "",
"subjectType": "StateChange.WorkflowAction",
"success": true,
"identifier": "14f9028614d09a0001bbaedc00004856",
"subject": "PendingShipmentOrder",
"verb": "Applied",
"message": "Workflow action succeeded.",
"metadata": [
{
"oldValue": "Validated",
"newValue": "PendingShipment"
},
{
"releaseShipmentDate": "2023-02-24T21:31:09.69Z"
}
],
"oldValue": "Validated",
"newValue": "PendingShipment",
"createDate": "2023-02-24T11:51:14.366Z"
},
{
"id": "6861efc4731f45d9a9bfafb300c70f49",
"correlationId": "",
"subjectType": "shipment.create",
"subject": "Shipments created",
"verb": "Created",
"message": "Created shipments 18.",
"createDate": "2023-02-24T12:04:45.252Z"
},
{
"id": "fa0ef0cfe8554d6398adafb300c70f52",
"correlationId": "",
"subjectType": "StateChange.WorkflowAction",
"success": true,
"identifier": "14f9028614d09a0001bbaedc00004856",
"subject": "AcceptOrder",
"verb": "Applied",
"message": "Workflow action succeeded.",
"metadata": [
{
"oldValue": "PendingShipment",
"newValue": "Accepted"
}
],
"oldValue": "PendingShipment",
"newValue": "Accepted",
"createDate": "2023-02-24T12:04:45.282Z"
}
],
"extendedProperties": [],
"discountThresholdMessages": [],
"auditInfo": {
"updateDate": "2023-02-24T12:04:45.301Z",
"createDate": "2023-02-24T11:50:30.382Z",
"updateBy": "UNKNOWN",
"createBy": "355060a60a5e48eeb7f2fb8d92af2ba5"
}
}