The identity and technical contract details declared by the specification.
orderShipmentNotificationMessage
message
Emitted once an order is packed, a batch is completed, or a wholesale order is picked up. Payload carries tracking and packing information.
orderStatusChangeMessage
message
Emitted on every change of an order processingstatus (back-order, onhold, submitted, pickinprogress, packinprogress, packed, awaitingpickup, enroute, delivered…
returnStatusChangeMessage
message
Emitted on every change of a return status (statuscreated, inprogress, enroute, returned).
receivingStatusChangeMessage
message
Emitted on every change of a receiving status (awaiting, inprogress, arrived, received).
Fulfillment_CommonBundle_ApiResource_IntegrationDataOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_Enum_PublicApiOrderStatus
string
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_OrderPackedItemOutput
object
3 properties
3 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PackingGroupOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiAccountForTradingPartnerOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiAccountTradingPartnerOutput
object
4 properties
4 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiCountryDetailOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiExtraDataOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderActionsRequiredOutput
object
15 properties
15 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderAttributeOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderCostsOutput
object
3 properties
3 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderDetailCustomDataOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderDetailOutput
object
41 properties
41 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemOutput
object
9 properties
9 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemProductLotOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderItemProductOutput
object
5 properties
5 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPackageDataOutput
object
11 properties
11 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPartItemOutput
object
1 property
1 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPartMainOrderOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderPartOutput
object
1 property
1 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderReferenceOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiOrderReturnDataOutput
object
1 property
1 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiPackageCartonLabelOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiPackedProductOutput
object
3 properties
3 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiRoutingDataOutput
object
1 property
1 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSerialNumberItemOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSerialNumberOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShipmentDataOutput
object
11 properties
11 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShippingLabelOutput
object
1 property
1 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiShippingOrderDetailAddressOutput
object
11 properties
11 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialInstructionDateOutput
object
3 properties
3 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialInstructionNameUrlOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiSpecialRequirementsOutput
object
8 properties
8 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiStoreNameOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_ApiResource_Output_Order_PublicApiWarehouseDetailOutput
object
4 properties
4 required
Fulfillment_IntegrationsBundle_ApiResource_ReturnOutput
object
16 properties
16 required
Fulfillment_IntegrationsBundle_Crate_NotifyShipmentPackingConfigurationPackingGroupOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_Crate_PublicApiReceivingItemDetailsOutput
object
5 properties
5 required
Fulfillment_IntegrationsBundle_Crate_PublicApiReturnItemOutput
object
5 properties
5 required
Fulfillment_IntegrationsBundle_Crate_ReturnItemDetailsPublicApiOutput
object
7 properties
7 required
Fulfillment_IntegrationsBundle_Crate_ReturnItemDetailsType
string
Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemLotPublicApiOutput
object
2 properties
2 required
Fulfillment_IntegrationsBundle_Crate_ReturnOrReceivingItemProductPublicApiOutput
object
3 properties
3 required
Fulfillment_IntegrationsBundle_Enum_ShipmentNotificationExtraDataType
string
Fulfillment_OrderBundle_Enum_OrderItemSource
string
Fulfillment_OrderBundle_Enum_OrderListStatus
string
Fulfillment_OrderBundle_Enum_OrderReferenceType
string
Fulfillment_OrderBundle_Enum_OrderSize
string
Fulfillment_PublicApiBundle_ApiResource_Carrier_PublicApiCarrierDetailOutput
object
2 properties
2 required
Fulfillment_PublicApiBundle_ApiResource_Order_PublicApiOrderTaxIdOutput
object
3 properties
3 required
Fulfillment_PublicApiBundle_ApiResource_ShippingMethod_PublicApiShippingMethodDetailOutput
object
3 properties
3 required
Fulfillment_UserBundle_Enum_TaxIdType
string
ShipMonk_Measurement_Output_DimensionsOutput
object
4 properties
4 required
ShipMonk_Measurement_Output_WeightOutput
object
2 properties
2 required
ShipMonk_Measurement_ValueObject_LengthUnit
string
ShipMonk_Measurement_ValueObject_WeightUnit
string
ShipMonk_Money_Output_MoneyOutput
object
2 properties
2 required
ShipMonk_OMS_Notification_ApiResource_CustomDataOutput
object
2 properties
2 required
ShipMonk_OMS_Notification_ApiResource_DateTimeOutput
object
3 properties
3 required
ShipMonk_OMS_Notification_ApiResource_MainOrderOutput
object
2 properties
2 required
ShipMonk_OMS_Notification_ApiResource_OrderPartOutput
object
1 property
1 required
ShipMonk_OMS_Notification_ApiResource_OrderPartsOutput
object
1 property
1 required
ShipMonk_OMS_Notification_ApiResource_PackageOutput
object
11 properties
11 required
ShipMonk_OMS_Notification_ApiResource_PackedOrderItemOutput
object
3 properties
3 required
ShipMonk_OMS_Notification_ApiResource_PackingLabelOutput
object
2 properties
2 required
ShipMonk_OMS_Notification_ApiResource_PalletOutput
object
4 properties
4 required
ShipMonk_OMS_Notification_ApiResource_RoutingOutput
object
1 property
1 required
ShipMonk_OMS_Notification_ApiResource_SerialNumberItemOutput
object
2 properties
2 required
ShipMonk_OMS_Notification_ApiResource_SerialNumbersOutput
object
2 properties
2 required
ShipMonk_OMS_Notification_ApiResource_ShipFromAddressOutput
object
11 properties
11 required
ShipMonk_OMS_Notification_ApiResource_ShipToAddressOutput
object
11 properties
11 required
ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationExtraDataOutput
object
2 properties
2 required
ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationItemWithProductLotOutput
object
8 properties
8 required
ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationLotOutput
object
2 properties
2 required
ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationOutput
object
30 properties
30 required
ShipMonk_OMS_Notification_ApiResource_ShipmentNotificationProductLotOutput
object
5 properties
5 required
ShipMonk_OMS_Order_Enum_OrderType
string
ShipMonk_OMS_Receiving_ApiResource_PublicApiCartonOutput
object
3 properties
3 required
ShipMonk_OMS_Receiving_ApiResource_PublicApiLpnOutput
object
2 properties
2 required
ShipMonk_OMS_Receiving_ApiResource_PublicApiPalletOutput
object
2 properties
2 required
ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingItemOutput
object
4 properties
4 required
ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingLineOutput
object
7 properties
7 required
ShipMonk_OMS_Receiving_ApiResource_PublicApiReceivingOutput
object
20 properties
20 required
ShipMonk_OMS_Receiving_Enum_LpnType
string
ShipMonk_OMS_Receiving_Enum_PublicApiReceivingStatus
string
ShipMonk_OMS_RequiredLabels_Enum_PackingLabelType
string
ShipMonk_ShippingConnector_ValueObject_PublicApiCarrierIdentifier
string
ShipMonk_Warehouse_Returns_Enum_ReturnEntitySource
string
ShipMonk_Warehouse_Returns_Enum_ReturnItemFinalDisposition
string
ShipMonk_Warehouse_Returns_Enum_ReturnItemStatus
string
ShipMonk_Warehouse_Returns_Enum_ReturnReason
string
ShipMonk_Warehouse_Returns_Enum_ReturnStatus
string
ShipMonk_Warehouse_WarehouseReceiving_Enum_WarehouseReceivingPacking
string
ShipMonk_WmsConnector_Order_ValueObject_WmsType
string
The full machine-readable AsyncAPI contract behind this narrative.
Other APIs ShipMonk publishes across the network.
