Shipment Notification

Once the order is fulfilled, ShipMonk can notify the 3rd party software of such event via webhook or Marketplace via direct integration. The payload consists of tracking and packing information.

Triggers for sending notification are:

• once regular order is packed
• batch is completed
• wholesale order is picked up

Notification is sent with delay which can be set per each store in ShipMonk OMS.

Your endpoint URL can be set up in the store detail in ShipMonk OMS. Please note that Basic Auth (username and password) is supported only.

We expect the status code 200 in response. When we receive another status call, we will be re-trying it for the next 3 days.

To test it, place the order and submit it for fulfilment. You have to make sure the inventory is available and order is all right first (it has set the shipping service and the address is valid). In production the order is shipped by our warehouse employees, while for testing you will have to call our complete-order endpoint.

Edge cases:

• If the order is big and cannot fit into a single packaging, we will send out multiple packages. Each package has its own tracking number inside of packages array.
• If the inventory of any SKU is not available, it is possible to manually split the order in the ShipMonk app and then we send Shipment Notification per each shipment.
• If the order is split and send out within multiple days, we send the Shipment Notification just once (when the first package is sent out)

fulfilled_quantity vs ordered_quantity: The value of these two fields might differ in case of partially fulfilled Orders. If a Product consists of 1x Item A and 1x Item B, when the customer orders 2 Products and the Shipment contains 1 piece of Item A and 2 pieces of Item B, then ordered_quantity = 2 but fulfilled_quantity = 1.

The list of carriers as we return them via webhook as carrier:

The above carriers cover standard shipments. In cases involving custom labels or freight shipments, the carrier field may contain values outside of this list.