Kibo Commerce · Schema
EntityModelOfShipment
CompanyCommerceE-CommerceHeadless CommerceOrder ManagementB2BConsumerInventoryFulfillment
Properties
| Name | Type | Description |
|---|---|---|
| _links | object | |
| acceptedDate | string | |
| alternateContact | object | |
| appeasementReason | object | |
| assignedLocationCode | string | |
| attributes | object | |
| auditInfo | object | |
| canceledItems | array | |
| carrier | string | |
| cartId | string | |
| changeMessages | array | |
| channel | string | |
| childShipmentNumbers | array | |
| currencyCode | string | |
| currentRunId | string | Run currently mutating this shipment (== Kibo.Jobs jobId); null when idle (FR-059d) |
| customer | object | |
| customerAccountId | integer | |
| customerAddressId | integer | |
| customerTaxId | string | |
| data | object | |
| deliveryWindow | object | |
| destination | object | |
| dutyAdjustment | number | |
| dutyTotal | number | |
| string | ||
| expectedDeliveryDate | string | |
| externalOrderId | string | |
| fulfillmentDate | string | |
| fulfillmentLocationCode | string | |
| fulfillmentPriority | integer | |
| fulfillmentStatus | string | |
| futureDate | string | |
| groupId | string | |
| handlingAdjustment | number | |
| handlingSubtotal | number | |
| handlingTaxAdjustment | number | |
| handlingTaxTotal | number | |
| handlingTotal | number | |
| holdReleaseDate | string | |
| isAutoAssigned | boolean | |
| isCrossDockEligible | boolean | |
| isDropship | boolean | |
| isExpress | boolean | |
| isFlatRateShipping | boolean | |
| isHistoricalImport | boolean | |
| isImmutable | boolean | |
| isOptInForSms | boolean | |
| items | array | |
| lastCancellationDate | string | |
| lineItemSubtotal | number | |
| lineItemTaxAdjustment | number | |
| lineItemTaxTotal | number | |
| lineItemTotal | number | |
| lowestComplianceLevel | string | |
| masterTrackingNumber | string | |
| minutesSinceOnWorkflowStep | integer | |
| minutesSinceOrdered | integer | |
| mutabilityInfo | object | |
| orderId | string | |
| orderNumber | integer | |
| orderSubmitDate | string | |
| orderType | string | |
| originalEdd | string | First expectedDeliveryDate this shipment ever carried (write-once, never cleared); non-null marks that the shipment has, at some point, had an EDD. Server-managed (FR-060); ignored on inbound writes. |
| originalShipmentNumber | integer | |
| packageReceivingEligible | boolean | FR-014/FR-016 multi-package-receiving eligibility signal. Only present when the MULTI_PACKAGE_RECEIVING_FOR_TRANSFER_SHIPMENTS tenant attribute is enabled and the transfer shipment has at least one pa |
| packages | array | |
| packagesPendingCount | integer | US4 progress display: packagesTotalCount minus packagesReceivedCount. Null when not eligible/flag disabled. |
| packagesReceivedCount | integer | US4 progress display: count of packages with receiptStatus=RECEIVED. Null when not eligible/flag disabled. |
| packagesTotalCount | integer | US4 progress display: total expected package count. Null when not eligible/flag disabled. |
| parentCheckoutNumber | integer | |
| parentShipmentNumber | integer | |
| paymentInvoice | object | |
| pickStatus | string | |
| pickType | string | |
| pickWaveNumber | integer | |
| pickupInfo | object | |
| priorityInfo | object | |
| readyForPickup | boolean | |
| readyForPickupDate | string | |
| readyToCapture | boolean | |
| reassignedItems | array | |
| receivedDate | string | |
| rejectedItems | array | |
| runInfo | array | Capped per-run history of operations that created/mutated this shipment (FR-059d) |
| sentCustomerAtStoreNotification | boolean | |
| sentCustomerInTransitNotification | boolean | |
| shipDate | string | |
| shipmentAdjustment | number | |
| shipmentAttributes | array | |
| shipmentConsolidationId | string | |
| shipmentGroup | string | |
| shipmentNotes | array | |
| shipmentNumber | integer | |
| shipmentStatus | string | |
| shipmentStatusReason | object | |
| shipmentType | string | Shipment type code |
| shippingAdjustment | number | |
| shippingMethodCode | string | |
| shippingMethodName | string | |
| shippingSubtotal | number | |
| shippingTaxAdjustment | number | |
| shippingTaxTotal | number | |
| shippingTotal | number | |
| shopperNotes | object | |
| siteId | integer | |
| slas | array | |
| substitutedItems | array | |
| taxData | object | |
| tenantId | integer | |
| total | number | |
| transferShipmentNumbers | array | |
| transferredItems | array | |
| transitTime | string | |
| userId | string | |
| workflowProcessContainerId | string | |
| workflowProcessId | string | |
| workflowProcessVersion | string | |
| workflowState | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/kibo-commerce/main/json-schema/kibo-commerce-entity-model-of-shipment-schema.json",
"title": "EntityModelOfShipment",
"x-generated": "2026-10-18",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/kibo-commerce-fulfillment-openapi.yml#/components/schemas/EntityModelOfShipment",
"properties": {
"_links": {
"$ref": "#/$defs/Links"
},
"acceptedDate": {
"format": "date-time",
"type": "string"
},
"alternateContact": {
"$ref": "#/$defs/FulfillmentAPIContact"
},
"appeasementReason": {
"$ref": "#/$defs/FulfillmentAPIAppeasementReason"
},
"assignedLocationCode": {
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"auditInfo": {
"$ref": "#/$defs/FulfillmentAPIAuditInfo"
},
"canceledItems": {
"items": {
"$ref": "#/$defs/CanceledItem"
},
"type": "array"
},
"carrier": {
"type": "string"
},
"cartId": {
"type": "string"
},
"changeMessages": {
"items": {
"$ref": "#/$defs/FulfillmentAPIChangeMessage"
},
"type": "array"
},
"channel": {
"type": "string"
},
"childShipmentNumbers": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"currencyCode": {
"type": "string"
},
"currentRunId": {
"description": "Run currently mutating this shipment (== Kibo.Jobs jobId); null when idle (FR-059d)",
"type": "string"
},
"customer": {
"$ref": "#/$defs/FulfillmentAPICustomer"
},
"customerAccountId": {
"format": "int32",
"type": "integer"
},
"customerAddressId": {
"format": "int32",
"type": "integer"
},
"customerTaxId": {
"type": "string"
},
"data": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"deliveryWindow": {
"$ref": "#/$defs/FulfillmentAPIDeliveryWindow"
},
"destination": {
"$ref": "#/$defs/FulfillmentAPIDestination"
},
"dutyAdjustment": {
"type": "number"
},
"dutyTotal": {
"type": "number"
},
"email": {
"type": "string"
},
"expectedDeliveryDate": {
"format": "date-time",
"type": "string"
},
"externalOrderId": {
"type": "string"
},
"fulfillmentDate": {
"format": "date-time",
"type": "string"
},
"fulfillmentLocationCode": {
"type": "string"
},
"fulfillmentPriority": {
"format": "int32",
"type": "integer"
},
"fulfillmentStatus": {
"enum": [
"NotFulfilled",
"Fulfilled"
],
"type": "string"
},
"futureDate": {
"format": "date-time",
"type": "string"
},
"groupId": {
"type": "string"
},
"handlingAdjustment": {
"type": "number"
},
"handlingSubtotal": {
"type": "number"
},
"handlingTaxAdjustment": {
"type": "number"
},
"handlingTaxTotal": {
"type": "number"
},
"handlingTotal": {
"type": "number"
},
"holdReleaseDate": {
"format": "date-time",
"type": "string"
},
"isAutoAssigned": {
"type": "boolean"
},
"isCrossDockEligible": {
"type": "boolean"
},
"isDropship": {
"type": "boolean"
},
"isExpress": {
"type": "boolean"
},
"isFlatRateShipping": {
"type": "boolean"
},
"isHistoricalImport": {
"type": "boolean"
},
"isImmutable": {
"type": "boolean"
},
"isOptInForSms": {
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/$defs/Item"
},
"type": "array"
},
"lastCancellationDate": {
"format": "date-time",
"type": "string"
},
"lineItemSubtotal": {
"type": "number"
},
"lineItemTaxAdjustment": {
"type": "number"
},
"lineItemTaxTotal": {
"type": "number"
},
"lineItemTotal": {
"type": "number"
},
"lowestComplianceLevel": {
"type": "string"
},
"masterTrackingNumber": {
"type": "string"
},
"minutesSinceOnWorkflowStep": {
"format": "int64",
"type": "integer"
},
"minutesSinceOrdered": {
"format": "int64",
"type": "integer"
},
"mutabilityInfo": {
"$ref": "#/$defs/MutabilityInfo"
},
"orderId": {
"type": "string"
},
"orderNumber": {
"format": "int32",
"type": "integer"
},
"orderSubmitDate": {
"format": "date-time",
"type": "string"
},
"orderType": {
"enum": [
"Offline",
"Online"
],
"type": "string"
},
"originalEdd": {
"description": "First expectedDeliveryDate this shipment ever carried (write-once, never cleared); non-null marks that the shipment has, at some point, had an EDD. Server-managed (FR-060); ignored on inbound writes.",
"format": "date-time",
"type": "string"
},
"originalShipmentNumber": {
"format": "int32",
"type": "integer"
},
"packageReceivingEligible": {
"description": "FR-014/FR-016 multi-package-receiving eligibility signal. Only present when the MULTI_PACKAGE_RECEIVING_FOR_TRANSFER_SHIPMENTS tenant attribute is enabled and the transfer shipment has at least one package; null otherwise so tenants without the attribute enabled see no shape change (US2-AC2).",
"type": "boolean"
},
"packages": {
"items": {
"$ref": "#/$defs/FulfillmentAPIPackage"
},
"type": "array"
},
"packagesPendingCount": {
"description": "US4 progress display: packagesTotalCount minus packagesReceivedCount. Null when not eligible/flag disabled.",
"format": "int32",
"type": "integer"
},
"packagesReceivedCount": {
"description": "US4 progress display: count of packages with receiptStatus=RECEIVED. Null when not eligible/flag disabled.",
"format": "int32",
"type": "integer"
},
"packagesTotalCount": {
"description": "US4 progress display: total expected package count. Null when not eligible/flag disabled.",
"format": "int32",
"type": "integer"
},
"parentCheckoutNumber": {
"format": "int32",
"type": "integer"
},
"parentShipmentNumber": {
"format": "int32",
"type": "integer"
},
"paymentInvoice": {
"$ref": "#/$defs/PaymentInvoice"
},
"pickStatus": {
"enum": [
"AVAILABLE",
"IN_WAVE",
"PICKED",
"TRANSFER",
"COMPLETE"
],
"type": "string"
},
"pickType": {
"enum": [
"NORMAL",
"SINGLE",
"MULTIPLE"
],
"type": "string"
},
"pickWaveNumber": {
"format": "int32",
"type": "integer"
},
"pickupInfo": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"priorityInfo": {
"$ref": "#/$defs/PriorityInfo"
},
"readyForPickup": {
"type": "boolean"
},
"readyForPickupDate": {
"format": "date-time",
"type": "string"
},
"readyToCapture": {
"type": "boolean"
},
"reassignedItems": {
"items": {
"$ref": "#/$defs/ReassignedItem"
},
"type": "array"
},
"receivedDate": {
"format": "date-time",
"type": "string"
},
"rejectedItems": {
"items": {
"$ref": "#/$defs/RejectedItem"
},
"type": "array"
},
"runInfo": {
"description": "Capped per-run history of operations that created/mutated this shipment (FR-059d)",
"items": {
"$ref": "#/$defs/RunInfo"
},
"type": "array"
},
"sentCustomerAtStoreNotification": {
"type": "boolean"
},
"sentCustomerInTransitNotification": {
"type": "boolean"
},
"shipDate": {
"format": "date-time",
"type": "string"
},
"shipmentAdjustment": {
"type": "number"
},
"shipmentAttributes": {
"items": {
"$ref": "#/$defs/FulfillmentAPIShipmentAttribute"
},
"type": "array"
},
"shipmentConsolidationId": {
"type": "string"
},
"shipmentGroup": {
"type": "string"
},
"shipmentNotes": {
"items": {
"$ref": "#/$defs/FulfillmentAPIShipmentNote"
},
"type": "array"
},
"shipmentNumber": {
"format": "int32",
"type": "integer"
},
"shipmentStatus": {
"enum": [
"READY",
"REASSIGNED",
"BACKORDER",
"CANCELED",
"FULFILLED",
"CUSTOMER_CARE",
"DELETED",
"FUTURE"
],
"type": "string"
},
"shipmentStatusReason": {
"$ref": "#/$defs/FulfillmentAPIShipmentStatusReason"
},
"shipmentType": {
"description": "Shipment type code",
"enum": [
"STH",
"FXCB",
"BOPIS",
"BOPIS_Curbside",
"Transfer",
"Curbside",
"Digital",
"Delivery"
],
"type": "string"
},
"shippingAdjustment": {
"type": "number"
},
"shippingMethodCode": {
"type": "string"
},
"shippingMethodName": {
"type": "string"
},
"shippingSubtotal": {
"type": "number"
},
"shippingTaxAdjustment": {
"type": "number"
},
"shippingTaxTotal": {
"type": "number"
},
"shippingTotal": {
"type": "number"
},
"shopperNotes": {
"$ref": "#/$defs/FulfillmentAPIShopperNotes"
},
"siteId": {
"format": "int32",
"type": "integer"
},
"slas": {
"items": {
"$ref": "#/$defs/Sla"
},
"type": "array"
},
"substitutedItems": {
"items": {
"$ref": "#/$defs/FulfillmentAPISubstitutedItem"
},
"type": "array"
},
"taxData": {
"type": "object"
},
"tenantId": {
"format": "int32",
"type": "integer"
},
"total": {
"type": "number"
},
"transferShipmentNumbers": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"transferredItems": {
"items": {
"$ref": "#/$defs/TransferredItem"
},
"type": "array"
},
"transitTime": {
"type": "string"
},
"userId": {
"type": "string"
},
"workflowProcessContainerId": {
"type": "string"
},
"workflowProcessId": {
"type": "string"
},
"workflowProcessVersion": {
"type": "string"
},
"workflowState": {
"$ref": "#/$defs/FulfillmentAPIWorkflowState"
}
},
"required": [
"shipmentType"
],
"type": "object",
"$defs": {
"BpmVariable": {
"properties": {
"name": {
"type": "string"
},
"oldValue": {
"type": "string"
},
"updateDate": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "string"
}
},
"title": "BpmVariable",
"type": "object"
},
"CanceledItem": {
"properties": {
"actualPrice": {
"type": "number"
},
"allocatedQuantity": {
"format": "int32",
"type": "integer"
},
"allowsBackOrder": {
"type": "boolean"
},
"allowsFutureAllocate": {
"type": "boolean"
},
"allowsSubstitution": {
"type": "boolean"
},
"appeasementReason": {
"$ref": "#/$defs/FulfillmentAPIAppeasementReason"
},
"attributes": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"auditInfo": {
"$ref": "#/$defs/FulfillmentAPIAuditInfo"
},
"autoSubstitution": {
"type": "boolean"
},
"backorderReleaseDate": {
"format": "date-time",
"type": "string"
},
"blockAssignment": {
"type": "boolean"
},
"bundleInfo": {
"$ref": "#/$defs/FulfillmentAPIBundleInfo"
},
"canceledReason": {
"$ref": "#/$defs/FulfillmentAPICanceledReason"
},
"cartItemId": {
"type": "string"
},
"childItemIds": {
"items": {
"type": "string"
},
"type": "array"
},
"condition": {
"type": "string"
},
"contractedPrice": {
"type": "number"
},
"creditCurrencyCode": {
"type": "string"
},
"creditValue": {
"type": "number"
},
"data": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"duty": {
"type": "number"
},
"expectedDeliveryDate": {
"format": "date-time",
"type": "string"
},
"fulfillmentFields": {
"items": {
"$ref": "#/$defs/FulfillmentAPIFulfillmentField"
},
"type": "array"
},
"giftCards": {
"items": {
"$ref": "#/$defs/FulfillmentAPIGiftCard"
},
"type": "array"
},
"giftMessage": {
"type": "string"
},
"goodsType": {
"enum": [
"Physical",
"Digital",
"DigitalCredit",
"DigitalGiftCard",
"Service"
],
"type": "string"
},
"handling": {
"type": "number"
},
"handlingDiscount": {
"type": "number"
},
"handlingTax": {
"type": "number"
},
"height": {
"type": "number"
},
"holdBlockAssignment": {
"type": "boolean"
},
"imageUrl": {
"type": "string"
},
"inventoryAllocations": {
"items": {
"$ref": "#/$defs/InventoryAllocation"
},
"type": "array"
},
"inventoryTags": {
"items": {
"$ref": "#/$defs/InventoryTag"
},
"type": "array"
},
"isAssemblyRequired": {
"type": "boolean"
},
"isGift": {
"type": "boolean"
},
"isPackagedStandAlone": {
"type": "boolean"
},
"isReservedInventory": {
"type": "boolean"
},
"isTaxable": {
"type": "boolean"
},
"itemDiscount": {
"type": "number"
},
"itemTax": {
"type": "number"
},
"length": {
"type": "number"
},
"lineId": {
"format": "int32",
"type": "integer"
},
"lineItemAdjustment": {
"type": "number"
},
"lineItemCost": {
"type": "number"
},
"locatorName": {
"type": "string"
},
"manageStock": {
"type": "boolean"
},
"name": {
"type": "string"
},
"optionAttributeFQN": {
"type": "string"
},
"options": {
"items": {
"$ref": "#/$defs/FulfillmentAPIProductOption"
},
"type": "array"
},
"originalLineId": {
"format": "int32",
"type": "integer"
},
"originalOrderItemId": {
"type": "string"
},
"originalQuantity": {
"format": "int32",
"type": "integer"
},
"overridePrice": {
"type": "number"
},
"parentItemId": {
"type": "string"
},
"partNumber": {
"type": "string"
},
"priceMode": {
"enum": [
"Internal",
"External"
],
"type": "string"
},
"productCode": {
"type": "string"
},
"purchaseLocation": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"readyForPickupQuantity": {
"format": "int32",
"type": "integer"
},
"returnRuleInfo": {
"$ref": "#/$defs/FulfillmentAPIReturnRuleInfo"
},
"serialNumber": {
"type": "string"
},
"shipmentItemAttributes": {
"items": {
"$ref": "#/$defs/ShipmentItemAttribute"
},
"type": "array"
},
"shipping": {
"type": "number"
},
"shippingDiscount": {
"type": "number"
},
"shippingTax": {
"type": "number"
},
"sku": {
"type": "string"
},
"stockValidationStatus": {
"type": "string"
},
"substituteInfo": {
"$ref": "#/$defs/FulfillmentAPISubstituteInfo"
},
"substituteQuantity": {
"format": "int32",
"type": "integer"
},
"substitutionType": {
"enum": [
"PRE_FULFILLMENT",
"AT_FULFILLMENT"
],
"type": "string"
},
"taxData": {
"type": "object"
},
"taxableHandling": {
"type": "number"
},
"taxableLineItemCost": {
"type": "number"
},
"taxableShipping": {
"type": "number"
},
"timeFenceDays": {
"format": "int32",
"type": "integer"
},
"transferQuantity": {
"description": "This is deprecated.",
"format": "int32",
"type": "integer"
},
"trueTransferQuantity": {
"description": "This is the actual quantity transferred.",
"format": "int32",
"type": "integer"
},
"unitPrice": {
"type": "number"
},
"upc": {
"type": "string"
},
"validatedQuantity": {
"format": "int32",
"type": "integer"
},
"variationProductCode": {
"type": "string"
},
"weight": {
"type": "number"
},
"weightUnit": {
"type": "string"
},
"weightedDutyAdjustment": {
"type": "number"
},
"weightedHandlingAdjustment": {
"type": "number"
},
"weightedHandlingTaxAdjustment": {
"type": "number"
},
"weightedLineItemTaxAdjustment": {
"type": "number"
},
"weightedOrderHandlingFee": {
"type": "number"
},
"weightedOrderHandlingFeeDiscount": {
"type": "number"
},
"weightedOrderHandlingFeeTax": {
"type": "number"
},
"weightedShipmentAdjustment": {
"type": "number"
},
"weightedShippingAdjustment": {
"type": "number"
},
"weightedShippingTaxAdjustment": {
"type": "number"
},
"width": {
"type": "number"
}
},
"title": "CanceledItem",
"type": "object"
},
"CartonizationDto": {
"properties": {
"attributes": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"boxes": {
"items": {
"$ref": "#/$defs/PackedBoxDto"
},
"type": "array"
},
"packingSuggestionId": {
"type": "string"
}
},
"title": "CartonizationDto",
"type": "object"
},
"DimensionsDto": {
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unit": {
"type": "string"
},
"width": {
"type": "number"
}
},
"title": "DimensionsDto",
"type": "object"
},
"FulfillmentAPIAddress": {
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"address4": {
"type": "string"
},
"addressType": {
"enum": [
"Commercial",
"Residential"
],
"type": "string"
},
"attributes": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"cityOrTown": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"isValidated": {
"type": "boolean"
},
"latitude": {
"type": "string"
},
"longitude": {
"type": "string"
},
"postalOrZipCode": {
"type": "string"
},
"stateOrProvince": {
"type": "string"
}
},
"title": "Address",
"type": "object"
},
"FulfillmentAPIAppeasementReason": {
"properties": {
"moreInfo": {
"type": "string"
},
"reasonCode": {
"type": "string"
}
},
"title": "AppeasementReason",
"type": "object"
},
"FulfillmentAPIAuditInfo": {
"properties": {
"createBy": {
"type": "string"
},
"createDate": {
"format": "date-time",
"type": "string"
},
"updateBy": {
"type": "string"
},
"updateDate": {
"format": "date-time",
"type": "string"
}
},
"title": "AuditInfo",
"type": "object"
},
"FulfillmentAPIBundleInfo": {
"properties": {
"attributes": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"imageUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"productCode": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unitPrice": {
"type": "number"
}
},
"title": "BundleInfo",
"type": "object"
},
"FulfillmentAPICanceledReason": {
"properties": {
"moreInfo": {
"type": "string"
},
"reasonCode": {
"type": "string"
}
},
"title": "CanceledReason",
"type": "object"
},
"FulfillmentAPIChangeMessage": {
"properties": {
"amount": {
"type": "number"
},
"appId": {
"type": "string"
},
"appKey": {
"type": "string"
},
"appName": {
"type": "string"
},
"appeasementReason": {
"$ref": "#/$defs/FulfillmentAPIAppeasementReason"
},
"attributes": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"changeMessageId": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"identifier": {
"type": "string"
},
"message": {
"type": "string"
},
"metadata": {
"type": "string"
},
"newValue": {
"type": "string"
},
"oldValue": {
"type": "string"
},
"subject": {
"type": "string"
},
"subjectType": {
"type": "string"
},
"success": {
"type": "boolean"
},
"userDisplayName": {
"type": "string"
},
"userFirstName": {
"type": "string"
},
"userId": {
"type": "string"
},
"userLastName": {
"type": "string"
},
"verb": {
"type": "string"
}
},
"title": "ChangeMessage",
"type": "object"
},
"FulfillmentAPIContact": {
"properties": {
"address": {
"$ref": "#/$defs/FulfillmentAPIAddress"
},
"attributes": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"companyOrOrganization": {
"type": "string"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"fullName": {
"type": "string"
},
"id": {
"format": "int32",
"type": "integer"
},
"lastNameOrSurname": {
"type": "string"
},
"middleNameOrInitial": {
"type": "string"
},
"phoneNumbers": {
"$ref": "#/$defs/FulfillmentAPIPhone"
},
"shortFullName": {
"type": "string"
}
},
"title": "Contact",
"type": "object"
},
"FulfillmentAPICustomer": {
"properties": {
"customerContact": {
"$ref": "#/$defs/FulfillmentAPIContact"
},
"data": {
"type": "object"
},
"isDestinationCommercial": {
"type": "boolean"
}
},
"title": "Customer",
"type": "object"
},
"FulfillmentAPIDeliveryWindow": {
"properties": {
"endTime": {
"format": "date-time",
"type": "string"
},
"startTime": {
"format": "date-time",
"type": "string"
}
},
"title": "DeliveryWindow",
"type": "object"
},
"FulfillmentAPIDestination": {
"properties": {
"data": {
"type": "object"
},
"destinationContact": {
"$ref": "#/$defs/FulfillmentAPIContact"
},
"isDestinationCommercial": {
"type": "boolean"
},
"locationCode": {
"type": "string"
}
},
"title": "Destination",
"type": "object"
},
"FulfillmentAPIFulfillmentField": {
"properties": {
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"userEnteredValue": {
"type": "object"
}
},
"title": "FulfillmentField",
"type": "object"
},
"FulfillmentAPIGiftCard": {
"properties": {
"activationDate": {
"format": "date-time",
"type": "string"
},
"cardNumber": {
"type": "string"
},
"code": {
"type": "string"
},
"creditType": {
"type": "string"
},
"creditValue": {
"type": "number"
},
"currencyCode": {
"type": "string"
},
"currentBalance": {
"type": "number"
},
"customerId": {
"format": "int32",
"type": "integer"
},
"expirationDate": {
"format": "date-time",
"type": "string"
},
"initialBalance": {
"type": "number"
}
},
"title": "GiftCard",
"type": "object"
},
"FulfillmentAPILink": {
"properties": {
"deprecation": {
"type": "string"
},
"href": {
"type": "string"
},
"hreflang": {
"type": "string"
},
"media": {
"type": "string"
},
"name": {
"type": "string"
},
"profile": {
"type": "string"
},
"rel": {
"$ref": "#/$defs/LinkRelation"
},
"template": {
"$ref": "#/$defs/UriTemplate"
},
"templated": {
"type": "boolean"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"title": "Link",
"type": "object"
},
"FulfillmentAPIMeasurement": {
"properties": {
"attributes": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"unit": {
"type": "string"
},
"value": {
"type": "number"
}
},
"title": "Measurement",
"type": "object"
},
"FulfillmentAPIPackage": {
"properties": {
"attributes": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"auditInfo": {
"$ref": "#/$defs/FulfillmentAPIAuditInfo"
},
"carrier": {
"type": "string"
},
"carrierName": {
"type": "string"
},
"cartonization": {
"$ref": "#/$defs/CartonizationDto"
},
"fullyMatched": {
"description": "Whether every line item's received+substituted quantity matched its expected quantity for this package. Null until received or when not eligible/flag disabled.",
"type": "boolean"
},
"fxcbDocumentsUrl": {
"type": "string"
},
"fxcbPackNotificationId": {
"type": "string"
},
"hasLabel": {
"type": "boolean"
},
"integratorId": {
"type": "string"
},
"labelFormat": {
"type": "string"
},
"manifestId": {
"type": "string"
},
"measurements": {
"$ref": "#/$defs/FulfillmentAPIPackageMeasurements"
},
"packageConsolidationId": {
"type": "string"
},
"packageId": {
"type": "string"
},
"packagingType": {
"type": "string"
},
"packingSlipItemDetails": {
"items": {
"$ref": "#/$defs/PackingSlipItemDetailDto"
},
"type": "array"
},
"packingSlipNumber": {
"format": "int32",
"type": "integer"
},
"receiptStatus": {
"description": "Package-level receipt status (NOT_RECEIVED/RECEIVED). Null when not eligible/tenant attribute disabled.",
"enum": [
"NOT_RECEIVED",
"RECEIVED"
],
"type": "string"
},
"receivedBy": {
"description": "User ID that received this package. Null until received or when not eligible/flag disabled.",
"type": "string"
},
"receivedDate": {
"description": "Timestamp this package was marked received. Null until received or when not eligible/flag disabled.",
"format": "date-time",
"type": "string"
},
"receivingMethod": {
"description": "Method used to receive this package (TRACKING_NUMBER_RECEIPT/ITEM_VALIDATION). Null until received or when not eligible/flag disabled.",
"enum": [
"TRACKING_NUMBER_RECEIPT",
"ITEM_VALIDATION",
"WHOLE_SHIPMENT_RECEIPT"
],
"type": "string"
},
"returnCarrier": {
"type": "string"
},
"returnTrackingNumbers": {
"items": {
"type": "string"
},
"type": "array"
},
"returnTrackings": {
"items": {
"$ref": "#/$defs/FulfillmentAPITracking"
},
"type": "array"
},
"shippingMethodCode": {
"type": "string"
},
"shippingMethodName": {
"type": "string"
},
"signatureRequired": {
"type": "boolean"
},
"stringBarcode": {
"type": "string"
},
"trackingNumbers": {
"items": {
"type": "string"
},
"type": "array"
},
"trackings": {
"items": {
"$ref": "#/$defs/FulfillmentAPITracking"
},
"type": "array
# --- truncated at 32 KB (92 KB total) ---
# Full source: https://artifacts.apis.io/kibo-commerce/json-schema/kibo-commerce-entity-model-of-shipment-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/kibo-commerce-entity-model-of-shipment"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.