Skip to main content

​
Method Signature

client.productData.getProductCloseOut(params?: GetProductCloseOutParams): Promise<any>
Retrieves a list of all products that are being closed out or discontinued by the supplier. This method helps identify clearance items and products that will no longer be available.

​
Parameters

This method does not require any specific parameters beyond the authentication credentials that are automatically included from the client configuration.
Authentication credentials (id and password) are automatically included from the client configuration and do not need to be passed as parameters.

​
Returns

​
ProductCloseOutArray
array
Array of products that are being closed out

​
Example

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

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

// Get all products being closed out
const closeOutProducts = await client.productData.getProductCloseOut();

console.log(closeOutProducts);

// Process close-out items
if (closeOutProducts && closeOutProducts.length > 0) {
  console.log(`Found ${closeOutProducts.length} products being closed out`);
  
  closeOutProducts.forEach(product => {
    console.log(`Product ${product.productId} - ${product.productName}`);
    console.log(`Close-out date: ${product.closeOutDate}`);
    console.log(`Available quantity: ${product.availableQuantity}`);
  });
}

​
Use Cases

  • Clearance Sales: Identify products for special clearance promotions
  • Inventory Planning: Plan for product discontinuation and find replacement items
  • Last Chance Purchases: Alert customers about products that won’t be restocked
  • Catalog Management: Remove or flag products that are being phased out

​
Best Practices

  • Call this method regularly (e.g., weekly) to stay updated on supplier closeouts
  • Cross-reference with inventory levels to determine purchase urgency
  • Notify customers who previously purchased or favorited closeout items
  • Consider bulk purchasing closeout items if you have consistent demand
  • Use getProductSellable to check if closeout products are still sellable
  • Use getProduct to get full details about closeout products
  • Check inventory levels with getInventoryLevels to see remaining stock

​
PromoStandards Documentation

For more details on the Product Data service, refer to the official PromoStandards documentation: Product Data Service 2.0.0

Build docs developers (and LLMs) love

Get started for freeTalk to us