Method
client.orderShipmentNotification.getOrderShipmentNotification(params: GetOrderShipmentNotificationParams): Promise<any>
Retrieves shipment notification details for orders, including tracking information and shipment status.
Parameters
The type of query to perform. Determines how shipment notifications will be retrieved.
Reference number for the order or shipment. Used when querying by specific reference.
Timestamp for filtering shipment notifications. Returns shipments created or updated after this time.
Returns
Returns a Promise that resolves to the shipment notification details. The response format depends on the client’s configured format (JSON or XML).
ShipmentNotificationArray
Array of shipment notification objects
Unique identifier for the shipment
Order number associated with this shipment
Date when the shipment was sent
Tracking number for the shipment
Array of items included in this shipment
Example
import { PromoStandards } from 'promostandards-sdk-js';
const client = new PromoStandards.Client({
id: 'your_account_id',
password: 'your_password',
endpoints: [
{
type: 'OrderShipmentNotification',
version: '2.0.0',
url: 'https://supplier.com/shipmentNotification',
},
],
});
const shipmentNotification = await client.orderShipmentNotification.getOrderShipmentNotification({
queryType: 'PO',
referenceNumber: 'PO-12345',
shipmentDateTimeStamp: '2024-01-01T00:00:00Z',
});
console.log(shipmentNotification);