Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/manishrc/promostandards-sdk-js/llms.txt

Use this file to discover all available pages before exploring further.

​
Method

client.orderStatus.getOrderStatusDetails(params: GetOrderStatusDetailsParams): Promise<any>
Retrieves detailed status information for orders based on query type and reference number or timestamp.

​
Parameters

​
queryType
string
required
The type of query to perform. Determines how the order status will be retrieved.
​
referenceNumber
string
Reference number for the order. Used when querying by specific order reference.
​
statusTimeStamp
string
required
Timestamp for filtering order status updates. Returns orders with status changes after this time.

​
Returns

Returns a Promise that resolves to the order status details. The response format depends on the client’s configured format (JSON or XML).
​
OrderStatusDetailsArray
array
Array of order status detail objects

​
Example

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

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

const orderStatus = await client.orderStatus.getOrderStatusDetails({
  queryType: 'PO',
  referenceNumber: 'PO-12345',
  statusTimeStamp: '2024-01-01T00:00:00Z',
});

console.log(orderStatus);

Build docs developers (and LLMs) love

Get started for freeTalk to us