List Policies
Returns the Replenishment Policy configurations of one warehouse specified by
its id path parameter, in evaluation order. Calculated per-Product output is
available from the Replenishment Report endpoint.
Product subjects keep their writable ID fields. An editor can additionally
request fields=merchants,product_profiles,handling_classes with narrow
nested fields such as fields:product_profiles=name,code to resolve only
the selected objects through included. Load complete choice lists from
their owning paged endpoints with similarly narrow fields:
/v1/system/merchants?fields=code,name,status(active by default);/v1/inventory/product-profiles?fields=name,code;/v1/inventory/handling-classes?fields=name,code&filter=warehouse_id:{id};/v1/inventory/warehouses/{id}/location-profiles?fields=name,status&filter=status:ready.
Load configured demand-period choices once from
/v1/inventory/warehouses/{id}/replenishment-policies/options.
Paging with cursor_start or cursor_end requires an explicit id or -id
sort: the cursor is a range over the identifier, which the default evaluation
order does not follow. A default-ordered listing therefore reports has_more
without continuation links; to enumerate a collection larger than one page,
request sort=id (or raise limit).
Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Path Parameters
The id of the referenced Warehouse.
Query Parameters
Specify additional fields of the ReplenishmentPolicy object to be included in the response.
basic, all, name, is_active, sort_order, merchant_ids, merchants, product_profile_ids, product_profiles, product_profile_match_mode, handling_class_ids, handling_classes, subject_readable, location_profile, demand_period_days, trigger_doi_days, target_doi_days, qualification_reason, flagged_sku_count, skipped_sku_count, slotting_forbidden_count, results_refresh_pending, created_at, updated_at Specify direct fields of selected Merchant objects to include under included.Merchant. Add merchants to the root fields parameter to return the relationship. type and id are always returned.
Specify direct fields of an included Merchant object.
code, name, status, created_at, updated_at Specify fields of selected ProductProfile objects to include under included.ProductProfile. Add product_profiles to the root fields parameter to return the relationship. type and id are always returned.
Specify fields of an included ProductProfile object.
basic, all, name, code, conditions, conditions_readable, matched_count, classification, created_at, updated_at Specify direct fields of selected HandlingClass objects to include under included.HandlingClass. Add handling_classes to the root fields parameter to return the relationship. type and id are always returned.
Specify direct fields of an included HandlingClass object.
name, code, sort_order, conditions, conditions_readable, matched_count, classification, created_at, updated_at Specify direct fields of the LocationProfile selected by each Policy.
Location Tags and Slot Types remain available from the Profile's own endpoint.
Specify direct fields of the included LocationProfile object.
name, description, status, member_count, match, match_readable, active_revision, pending_revision, used_by, created_at, updated_at Using the filtering syntax, you may filter the results using the following fields:
idnameis_activelocation_profile_id
The default sort order is ascending by sort_order, which is the order in which policies are evaluated for a Product. Every sort carries an ascending id tie-break, because duplicate sort_order values are allowed.
The following fields are available for sorting:
idnamesort_orderupdated_at
If specified as 1, the meta.count property of the response will be present and populated with the total count of items
matching the query before any paging is applied. This is not included by default to improve performance in some edge
cases and is not required to perform paging using the next property of the response.
See paging parameters for more information.
0 <= x <= 1A cursor for use in pagination which defines the last id of the next page of results, non-inclusive.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the starting id of the next page of results.
See paging parameters for more information on paging.
A limit on the number of objects to be returned.
1 <= x <= 1000100
Response
A dictionary with a collection property containing up to limit
ReplenishmentPolicy objects matching the query.
A list of ReplenishmentPolicy objects.
True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.
The resource path for the next page of results if any are expected.
The resource path for the previous page of results if any are expected.
Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.
Additional metadata pertaining to the response.