Skip to main content

Price Export Custom Ep

POST 
/v1/price/export_custom

Export Custom Supply Prices

An integration endpoint that returns a response of supply items based on the specified conditions.

Required Scopes (ipd.w)

Request​

params: None
No parameters are required for this request. The as_of date is defaulted to the current date, and the supply items are filtered based on the most recent effective_from and effective_to dates.

reqs: None
No specific requirements. The endpoint will return the same list of prices as viewed from Supply Management, filtered to today’s date, similar to the price_management/overview endpoint.


Response​

The response includes detailed information about supply items from the following collections:

Price excel file export: An Excel file containing detailed price information structured into the following columns:

  • curve_id: Unique identifier for the price curve.
  • price_id: Unique identifier for the price.
  • city: The city where the supply item is located.
  • contract: Contract information related to the supply item.
  • product: The product name associated with the supply item.
  • product_id: Unique identifier for the product.
  • supplier: Name of the supplier providing the supply item.
  • supplier_id: Unique identifier for the supplier.
  • terminal: Terminal information for the supply item.
  • terminal_id: Unique identifier for the terminal.
  • store_number: Store number associated with the supply item.
  • store_id: Unique identifier for the store.
  • price_type: Type of price (e.g., rack, contract).
  • effective_from: Start date when the price is effective.
  • effective_to: End date when the price is effective.
  • expire: Expiry status of the price.
  • disabled: Disabled status of the price.
  • disabled_by: User who disabled the price.
  • disabled_until: Date until which the price is disabled.
  • disabled_reason: Reason for disabling the price.
  • updated_by: User who last updated the price.
  • updated_on: Timestamp of the last update.
  • extra_data:
    • source_id: Source identifier for the supply item.
    • source_system_id: Source system identifier for the supply item.

Responses​

Successful Response

Loading...