cURL

curl --request GET \
  --url 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count"
headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)
print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count', options)
  .then(response => response.json())
  .then(response => console.log(response));

<?php

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer <token>']);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count", nil)
    req.Header.Add("Authorization", "Bearer <token>")
    response, _ := http.DefaultClient.Do(req)
    defer response.Body.Close()
    body, _ := io.ReadAll(response.Body)
    fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count')
request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.read_body

{
  "resource": {
    "type": "ReplenishmentPolicy",
    "id": 7,
    "name": "Fast Movers - Forward Pick",
    "is_active": true,
    "sort_order": 10,
    "merchant_ids": [
      2,
      7
    ],
    "product_profile_ids": [
      12,
      15
    ],
    "product_profile_match_mode": "any",
    "handling_class_ids": [
      4
    ],
    "merchants": [
      {
        "type": "Merchant",
        "id": 2
      },
      {
        "type": "Merchant",
        "id": 7
      }
    ],
    "product_profiles": [
      {
        "type": "ProductProfile",
        "id": 12
      },
      {
        "type": "ProductProfile",
        "id": 15
      }
    ],
    "handling_classes": [
      {
        "type": "HandlingClass",
        "id": 4
      }
    ],
    "location_profile": {
      "type": "LocationProfile",
      "id": 3
    },
    "demand_period_days": 30,
    "trigger_doi_days": 7,
    "target_doi_days": 21,
    "qualification_reason": null,
    "created_at": "2026-08-01T09:30:00Z",
    "updated_at": "2026-08-12T10:15:00Z"
  },
  "included": {
    "Merchant": [
      {
        "type": "Merchant",
        "id": 2,
        "code": "retail_direct",
        "name": "Retail Direct",
        "status": "active"
      },
      {
        "type": "Merchant",
        "id": 7,
        "code": "marketplace",
        "name": "Marketplace",
        "status": "active"
      }
    ],
    "ProductProfile": [
      {
        "type": "ProductProfile",
        "id": 12,
        "name": "Regulated Aerosols",
        "code": "regulated_aerosols"
      },
      {
        "type": "ProductProfile",
        "id": 15,
        "name": "Fast Movers",
        "code": "fast_movers"
      }
    ],
    "HandlingClass": [
      {
        "type": "HandlingClass",
        "id": 4,
        "name": "Hazmat",
        "code": "hazmat"
      }
    ],
    "LocationProfile": [
      {
        "type": "LocationProfile",
        "id": 3,
        "name": "Pick Face",
        "status": "ready",
        "member_count": 1275
      }
    ]
  },
  "meta": {
    "processing_time": 0.018
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

Replenishment

Get Policy

Returns one ReplenishmentPolicy of one warehouse specified by the id and policy_id path parameters.

qualification_reason is derived on read and reports why the Policy currently falls through during evaluation. The three published counts are null until the warehouse publishes a Replenishment generation.

To resolve the current editor selections, add fields=merchants,product_profiles,handling_classes and request only direct display fields such as fields:merchants=code,name,status. The writable ID properties remain the mutation contract, and selected relationships never recursively expand their own relationships.

GET

inventory

warehouses

{id}

replenishment-policies

{policy_id}

cURL

curl --request GET \
  --url 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count"
headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)
print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count', options)
  .then(response => response.json())
  .then(response => console.log(response));

<?php

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer <token>']);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count", nil)
    req.Header.Add("Authorization", "Bearer <token>")
    response, _ := http.DefaultClient.Do(req)
    defer response.Body.Close()
    body, _ := io.ReadAll(response.Body)
    fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/replenishment-policies/7?fields=merchants,product_profiles,handling_classes&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count')
request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.read_body

{
  "resource": {
    "type": "ReplenishmentPolicy",
    "id": 7,
    "name": "Fast Movers - Forward Pick",
    "is_active": true,
    "sort_order": 10,
    "merchant_ids": [
      2,
      7
    ],
    "product_profile_ids": [
      12,
      15
    ],
    "product_profile_match_mode": "any",
    "handling_class_ids": [
      4
    ],
    "merchants": [
      {
        "type": "Merchant",
        "id": 2
      },
      {
        "type": "Merchant",
        "id": 7
      }
    ],
    "product_profiles": [
      {
        "type": "ProductProfile",
        "id": 12
      },
      {
        "type": "ProductProfile",
        "id": 15
      }
    ],
    "handling_classes": [
      {
        "type": "HandlingClass",
        "id": 4
      }
    ],
    "location_profile": {
      "type": "LocationProfile",
      "id": 3
    },
    "demand_period_days": 30,
    "trigger_doi_days": 7,
    "target_doi_days": 21,
    "qualification_reason": null,
    "created_at": "2026-08-01T09:30:00Z",
    "updated_at": "2026-08-12T10:15:00Z"
  },
  "included": {
    "Merchant": [
      {
        "type": "Merchant",
        "id": 2,
        "code": "retail_direct",
        "name": "Retail Direct",
        "status": "active"
      },
      {
        "type": "Merchant",
        "id": 7,
        "code": "marketplace",
        "name": "Marketplace",
        "status": "active"
      }
    ],
    "ProductProfile": [
      {
        "type": "ProductProfile",
        "id": 12,
        "name": "Regulated Aerosols",
        "code": "regulated_aerosols"
      },
      {
        "type": "ProductProfile",
        "id": 15,
        "name": "Fast Movers",
        "code": "fast_movers"
      }
    ],
    "HandlingClass": [
      {
        "type": "HandlingClass",
        "id": 4,
        "name": "Hazmat",
        "code": "hazmat"
      }
    ],
    "LocationProfile": [
      {
        "type": "LocationProfile",
        "id": 3,
        "name": "Pick Face",
        "status": "ready",
        "member_count": 1275
      }
    ]
  },
  "meta": {
    "processing_time": 0.018
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

Authorizations

Authorization

string

header

required

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

integer<int32>

required

The id of the referenced Warehouse.

policy_id

integer<int32>

required

The id of the referenced ReplenishmentPolicy.

Query Parameters

fields

enum<string>[]

Specify additional fields of the ReplenishmentPolicy object to be included in the response.

Available options:

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

fields:merchants

enum<string>[]

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.

Available options:

code,

name,

status,

created_at,

updated_at

fields:product_profiles

enum<string>[]

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.

Available options:

basic,

all,

name,

code,

conditions,

conditions_readable,

matched_count,

classification,

created_at,

updated_at

fields:handling_classes

enum<string>[]

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.

Available options:

name,

code,

sort_order,

conditions,

conditions_readable,

matched_count,

classification,

created_at,

updated_at

fields:location_profile

enum<string>[]

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.

Available options:

name,

description,

status,

member_count,

match,

match_readable,

active_revision,

pending_revision,

used_by,

created_at,

updated_at

Response

A dictionary with a resource property that contains the requested ReplenishmentPolicy object.

resource

ReplenishmentPolicy · object

A Replenishment Policy configuration for one warehouse. The Policy selects Products by Merchant, Product Profile, and Handling Class, then applies Trigger and Target days-of-inventory thresholds to one Location Profile.

Show child attributes

Example:

{
  "type": "ReplenishmentPolicy",
  "id": 7,
  "name": "Fast Movers - Forward Pick",
  "is_active": true,
  "sort_order": 10,
  "merchant_ids": [2, 7],
  "product_profile_ids": [12, 15],
  "product_profile_match_mode": "any",
  "handling_class_ids": [4],
  "location_profile": { "type": "LocationProfile", "id": 3 },
  "demand_period_days": 30,
  "trigger_doi_days": 7,
  "target_doi_days": 21,
  "qualification_reason": null,
  "created_at": "2026-08-01T09:30:00Z",
  "updated_at": "2026-08-12T10:15:00Z"
}

included

object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

Show child attributes

Example:

{}

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Get Policy

Authorizations

Path Parameters

Query Parameters

Response