ShipmentNotification()

This method is called when a shipment is created for one or more items in one or more sales orders. A single shipment may contain items from multiple sales orders, and a single sales order may be fulfilled by multiple shipments.

Syntax

module.exports = async function ShipmentNotification(request) {
// Your code here
}
import {
ShipmentNotificationRequest,
ShipmentNotificationResponse
} from "@shipengine/connect-order-source-api";
export const ShipmentNotification = async (
request: ShipmentNotificationRequest
): Promise<ShipmentNotificationResponse> => {
// Your code here
}

ShipmentNotificationRequest

A request to notify an order source that an order has been shipped

NameTypeNullable?Description
auth

Auth

The authorization information necessary to fulfill this request.

notifications

ShipmentNotification[]

A list of orders to notify the order source about

sales_order_status_mapping

SalesOrderStatusMapping[]

seller specified mappings for custom statuses coming from the 3rd parties api and the SalesOrderStatus they should map to.

transaction_idstring

A randomly generated transaction ID, used to correlate the request and response

ShipmentNotificationResponse

The response for a NotifyShipments method

NameTypeNullable?Description
notification_results

ShipmentNotificationResult[]

A list of results for shipment notifications