Orders and Status

The PromoStandards SDK provides comprehensive order management capabilities including purchase order submission, status tracking, shipment notifications, and invoice retrieval. This guide covers all order-related services.

Overview

The SDK provides four order-related services:

PurchaseOrder - Submit purchase orders to suppliers
OrderStatus - Track order status and details
OrderShipmentNotification - Receive shipment updates
Invoice - Retrieve invoices for completed orders

Setup

Configure your client with the necessary order endpoints:

import { PromoStandards } from 'promostandards-sdk-js';

const supplier = new PromoStandards.Client({
  id: 'your_account_id',
  password: 'your_password',
  endpoints: [
    {
      type: 'PurchaseOrder',
      version: '1.0.0',
      url: 'https://supplier.com/purchaseOrder',
    },
    {
      type: 'OrderStatus',
      version: '1.0.0',
      url: 'https://supplier.com/orderStatus',
    },
    {
      type: 'OrderShipmentNotification',
      version: '1.0.0',
      url: 'https://supplier.com/shipmentNotification',
    },
    {
      type: 'Invoice',
      version: '1.0.0',
      url: 'https://supplier.com/invoice',
    },
  ],
});

Submitting Purchase Orders

Prepare order data

Build your purchase order with all required information:

const orderData = {
  orderType: 'Regular',
  orderNumber: 'PO-2024-001',
  orderDate: '2024-03-15T10:00:00Z',
  totalAmount: 1250.00,
  rush: false,
  currency: 'USD',
  termsAndConditions: 'Net 30',
  shipments: [
    {
      allowConsolidation: true,
      blindShip: false,
      packingListRequired: true,
      freightDetails: {
        carrier: 'UPS',
        service: 'Ground',
      },
      shipTo: {
        shipmentId: 1,
        attentionTo: 'John Doe',
        companyName: 'ABC Company',
        address1: '123 Main St',
        city: 'New York',
        region: 'NY',
        postalCode: '10001',
        country: 'US',
        email: '[email protected]',
        phone: '555-0100',
      },
    },
  ],
  lineItems: [
    {
      lineNumber: 1,
      description: 'Blue T-Shirt - Large',
      lineType: 'New',
      quantity: {
        uom: 'EA',
        value: 100,
      },
      toleranceDetails: {
        tolerance: 5,
      },
      allowPartialShipments: true,
      unitPrice: 10.00,
      lineItemTotal: 1000.00,
      requestedShipDate: '2024-04-01T00:00:00Z',
      productId: 'SHIRT-001',
    },
  ],
};

Submit the order

Send the purchase order to the supplier:

const response = await supplier.purchaseOrder.sendPO(orderData);

if (response?.POResponse) {
  console.log('Order submitted successfully');
  console.log('Order ID:', response.POResponse.orderNumber);
  console.log('Status:', response.POResponse.status);
}

The purchase order structure is complex. Refer to the templates.ts:403 for the complete structure.

Tracking Order Status

Getting Order Status Types

First, retrieve the available status types from the supplier:

const statusTypes = await supplier.orderStatus.getOrderStatusTypes({});

if (statusTypes?.StatusTypeArray) {
  for (const status of statusTypes.StatusTypeArray) {
    console.log(`${status.statusId}: ${status.statusName}`);
  }
}

Checking Order Status Details

Track a specific order’s status:

const orderStatus = await supplier.orderStatus.getOrderStatusDetails({
  queryType: 1, // Query by purchase order number
  referenceNumber: 'PO-2024-001',
  statusTimeStamp: '2024-01-01T00:00:00Z',
});

if (orderStatus?.OrderStatusArray) {
  for (const order of orderStatus.OrderStatusArray) {
    console.log('Order:', order.orderNumber);
    console.log('Status:', order.orderStatus);
    console.log('Status Time:', order.statusTime);
  }
}

Query Types

Query Type	Description
1	Query by Purchase Order Number
2	Query by Customer Order Number
3	Query by Tracking Number
4	Query by all orders since timestamp

// Get all orders updated since a specific date
const recentOrders = await supplier.orderStatus.getOrderStatusDetails({
  queryType: 4,
  statusTimeStamp: '2024-03-01T00:00:00Z',
});

Retrieving Shipment Notifications

Get shipment tracking information:

const shipments = await supplier.orderShipmentNotification
  .getOrderShipmentNotification({
    queryType: 1, // Query by purchase order number
    referenceNumber: 'PO-2024-001',
  });

if (shipments?.ShipmentNotificationArray) {
  for (const shipment of shipments.ShipmentNotificationArray) {
    console.log('Tracking Number:', shipment.trackingNumber);
    console.log('Carrier:', shipment.carrier);
    console.log('Ship Date:', shipment.shipDate);
    console.log('Estimated Delivery:', shipment.estimatedDeliveryDate);
  }
}

Query by Timestamp

Retrieve all shipments since a specific date:

const recentShipments = await supplier.orderShipmentNotification
  .getOrderShipmentNotification({
    queryType: 2, // Query by timestamp
    shipmentDateTimeStamp: '2024-03-01T00:00:00Z',
  });

Retrieving Invoices

Get invoice information for orders:

const invoices = await supplier.invoice.getInvoices({
  productId: 'SHIRT-001',
  queryType: 1, // Query by purchase order number
  referenceNumber: 'PO-2024-001',
});

if (invoices?.InvoiceArray) {
  for (const invoice of invoices.InvoiceArray) {
    console.log('Invoice Number:', invoice.invoiceNumber);
    console.log('Invoice Date:', invoice.invoiceDate);
    console.log('Amount:', invoice.totalAmount);
    console.log('Currency:', invoice.currency);
  }
}

Invoice Query Types

Query Type	Description
1	Query by Purchase Order Number
2	Query by Invoice Date
3	Query by Timestamp

// Get invoices by date
const invoicesByDate = await supplier.invoice.getInvoices({
  productId: 'SHIRT-001',
  queryType: 2,
  requestedDate: '2024-03-15',
});

// Get invoices since timestamp
const recentInvoices = await supplier.invoice.getInvoices({
  productId: 'SHIRT-001',
  queryType: 3,
  availableTimeStamp: '2024-03-01T00:00:00Z',
});

Complete Order Workflow

Here’s a complete example that places an order and tracks it through fulfillment:

import { PromoStandards } from 'promostandards-sdk-js';

async function placeAndTrackOrder() {
  const supplier = new PromoStandards.Client({
    id: 'account_id',
    password: 'password',
    endpoints: [
      {
        type: 'PurchaseOrder',
        version: '1.0.0',
        url: 'https://supplier.com/purchaseOrder',
      },
      {
        type: 'OrderStatus',
        version: '1.0.0',
        url: 'https://supplier.com/orderStatus',
      },
      {
        type: 'OrderShipmentNotification',
        version: '1.0.0',
        url: 'https://supplier.com/shipmentNotification',
      },
      {
        type: 'Invoice',
        version: '1.0.0',
        url: 'https://supplier.com/invoice',
      },
    ],
  });

  const orderNumber = `PO-${Date.now()}`;

  try {
    // Step 1: Submit purchase order
    console.log('Submitting order...');
    const orderResponse = await supplier.purchaseOrder.sendPO({
      orderType: 'Regular',
      orderNumber: orderNumber,
      orderDate: new Date().toISOString(),
      totalAmount: 1000.00,
      rush: false,
      currency: 'USD',
      termsAndConditions: 'Net 30',
      shipments: [
        {
          allowConsolidation: true,
          blindShip: false,
          packingListRequired: true,
          freightDetails: {
            carrier: 'UPS',
            service: 'Ground',
          },
          shipTo: {
            shipmentId: 1,
            companyName: 'Test Company',
            address1: '123 Main St',
            city: 'New York',
            region: 'NY',
            postalCode: '10001',
            country: 'US',
            email: '[email protected]',
            phone: '555-0100',
          },
        },
      ],
      lineItems: [
        {
          lineNumber: 1,
          description: 'T-Shirt - Large',
          lineType: 'New',
          quantity: { uom: 'EA', value: 100 },
          toleranceDetails: { tolerance: 5 },
          allowPartialShipments: true,
          unitPrice: 10.00,
          lineItemTotal: 1000.00,
          productId: 'SHIRT-001',
        },
      ],
    });

    console.log('Order submitted:', orderNumber);

    // Step 2: Wait a moment, then check status
    await new Promise((resolve) => setTimeout(resolve, 5000));

    console.log('Checking order status...');
    const status = await supplier.orderStatus.getOrderStatusDetails({
      queryType: 1,
      referenceNumber: orderNumber,
      statusTimeStamp: new Date(Date.now() - 86400000).toISOString(),
    });

    if (status?.OrderStatusArray?.[0]) {
      console.log('Current status:', status.OrderStatusArray[0].orderStatus);
    }

    // Step 3: Check for shipment notifications
    console.log('Checking shipments...');
    const shipments = await supplier.orderShipmentNotification
      .getOrderShipmentNotification({
        queryType: 1,
        referenceNumber: orderNumber,
      });

    if (shipments?.ShipmentNotificationArray?.length > 0) {
      console.log('Shipments found:');
      for (const shipment of shipments.ShipmentNotificationArray) {
        console.log(`  Tracking: ${shipment.trackingNumber}`);
        console.log(`  Carrier: ${shipment.carrier}`);
      }
    } else {
      console.log('No shipments yet');
    }

    // Step 4: Check for invoices
    console.log('Checking invoices...');
    const invoices = await supplier.invoice.getInvoices({
      productId: 'SHIRT-001',
      queryType: 1,
      referenceNumber: orderNumber,
    });

    if (invoices?.InvoiceArray?.length > 0) {
      console.log('Invoices found:');
      for (const invoice of invoices.InvoiceArray) {
        console.log(`  Invoice #${invoice.invoiceNumber}`);
        console.log(`  Amount: $${invoice.totalAmount}`);
      }
    } else {
      console.log('No invoices yet');
    }
  } catch (error) {
    console.error('Error in order workflow:', error);
  }
}

placeAndTrackOrder();

Order Contact Types

When submitting purchase orders, you can include multiple contact types:

orderContactArray: [
  {
    contactType: 'Billing',
    attentionTo: 'Accounts Payable',
    companyName: 'ABC Company',
    address1: '456 Finance Blvd',
    city: 'New York',
    region: 'NY',
    postalCode: '10002',
    country: 'US',
    email: '[email protected]',
  },
  {
    contactType: 'Acknowledgement',
    email: '[email protected]',
  },
]

Digital Proofs

Request digital proofs for decorated products:

digitalProof: {
  required: true,
  addresses: [
    {
      type: 'To',
      email: '[email protected]',
      lineItemGroupingId: 1,
    },
  ],
}

Digital proof approval may delay order processing. Set realistic ship dates when proofs are required.

Method Reference

sendPO

See templates.ts:403 for the complete purchase order structure. Key parameters:

Parameter	Type	Required	Description
`orderType`	string	Yes	Regular, Sample, etc.
`orderNumber`	string	Yes	Your PO number
`orderDate`	string	Yes	ISO 8601 timestamp
`totalAmount`	number	Yes	Order total amount
`currency`	string	Yes	Currency code
`shipments`	array	Yes	Shipment details array
`lineItems`	array	Yes	Line items array

getOrderStatusDetails

Parameter	Type	Required	Description
`queryType`	number	Yes	Query type (1-4)
`statusTimeStamp`	string	Yes	ISO 8601 timestamp
`referenceNumber`	string	No	PO or order number

getOrderShipmentNotification

Parameter	Type	Required	Description
`queryType`	number	Yes	1=PO number, 2=timestamp
`referenceNumber`	string	No	PO number
`shipmentDateTimeStamp`	string	No	ISO 8601 timestamp

getInvoices

Parameter	Type	Required	Description
`productId`	string	Yes	Product identifier
`queryType`	number	Yes	Query type (1-3)
`referenceNumber`	string	No	PO number
`requestedDate`	string	No	Date for query type 2
`availableTimeStamp`	string	No	Timestamp for query type 3

Best Practices

Validate before submitting

Check inventory and pricing before submitting purchase orders.

Use unique order numbers

Include timestamps or unique identifiers in PO numbers to avoid conflicts.

Poll status regularly

Set up scheduled jobs to check order status and shipment notifications.

Handle errors gracefully

Purchase order submission can fail for many reasons. Implement retry logic and user notifications.

Store tracking data

Persist tracking numbers and shipment data for customer service purposes.

Next Steps

Pricing and Configuration

Get pricing before placing orders

Managing Inventory

Validate stock before orders

Get Started

Core Concepts

Guides

Overview

Setup

Submitting Purchase Orders

Tracking Order Status

Getting Order Status Types

Checking Order Status Details

Query Types

Retrieving Shipment Notifications

Query by Timestamp

Retrieving Invoices

Invoice Query Types

Complete Order Workflow

Order Contact Types

Digital Proofs

Method Reference

sendPO

getOrderStatusDetails

getOrderShipmentNotification

getInvoices

Best Practices

Next Steps

Pricing and Configuration

Managing Inventory

Build docs developers (and LLMs) love

Get Started

Core Concepts

Guides

​Overview

​Setup

​Submitting Purchase Orders

​Tracking Order Status

​Getting Order Status Types

​Checking Order Status Details

​Query Types

​Retrieving Shipment Notifications

​Query by Timestamp

​Retrieving Invoices

​Invoice Query Types

​Complete Order Workflow

​Order Contact Types

​Digital Proofs

​Method Reference

​sendPO

​getOrderStatusDetails

​getOrderShipmentNotification

​getInvoices

​Best Practices

​Next Steps

Pricing and Configuration

Managing Inventory

Build docs developers (and LLMs) love

Overview

Setup

Submitting Purchase Orders

Tracking Order Status

Getting Order Status Types

Checking Order Status Details

Query Types

Retrieving Shipment Notifications

Query by Timestamp

Retrieving Invoices

Invoice Query Types

Complete Order Workflow

Order Contact Types

Digital Proofs

Method Reference

sendPO

getOrderStatusDetails

getOrderShipmentNotification

getInvoices

Best Practices

Next Steps