How to get FOB points
Function getFobPoints
FOB (Free On Board) points represent the shipping origin locations where products can be shipped from. In order to get all the FOB points for a given product we need to use Product, Pricing and Configuration service (PPC). Our API allows easy access by a GET request to our fob-points endpoint.
HTTP VERB: GET
URL: https://api.psrestful.com/v1.0.0/suppliers/{SUPPLIER_CODE}/fob-points/{PRODUCT_ID}/
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
localization_country | string | No | Country code (default: US) |
localization_language | string | No | Language code (default: en) |
environment | string | No | Environment: PROD or STAGING (default: PROD) |
Example Request
curl -X GET "https://api.psrestful.com/v1.0.0/suppliers/alphabroder/fob-points/C1717/" \
-H "X-API-Key: your-api-key"Example Response
This is the response from calling with:
SUPPLIER_CODE = alphabroder
PRODUCT_ID = C1717
The response has been truncated to show 3 FOB points:
{
"FobPointArray": {
"FobPoint": [
{
"fobId": "BX",
"fobPostalCode": "06610",
"fobCity": "BRIDGEPORT",
"fobState": "CT",
"fobCountry": "US",
"CurrencySupportedArray": {
"CurrencySupported": [
{
"currency": "USD"
}
]
},
"ProductArray": {
"Product": [
{
"productId": "C1717"
}
]
}
},
{
"fobId": "CC",
"fobPostalCode": "60490",
"fobCity": "Bolingbrook",
"fobState": "IL",
"fobCountry": "US",
"CurrencySupportedArray": {
"CurrencySupported": [
{
"currency": "USD"
}
]
},
"ProductArray": {
"Product": [
{
"productId": "C1717"
}
]
}
},
{
"fobId": "CN",
"fobPostalCode": "93725",
"fobCity": "FRESNO",
"fobState": "CA",
"fobCountry": "US",
"CurrencySupportedArray": {
"CurrencySupported": [
{
"currency": "USD"
}
]
},
"ProductArray": {
"Product": [
{
"productId": "C1717"
}
]
}
}
]
},
"ErrorMessage": null
}Response Structure
| Field | Description |
|---|---|
FobPointArray | Array of FOB (shipping origin) points |
fobId | Unique identifier for the FOB point (used in pricing calls) |
fobPostalCode | Postal code of the warehouse |
fobCity | City of the warehouse |
fobState | State/province of the warehouse |
fobCountry | Country of the warehouse |
CurrencySupportedArray | Currencies available at this location |
ProductArray | Products available at this FOB point |
Use Cases
- Shipping optimization: Choose the closest warehouse to reduce shipping costs
- Pricing requests:
fob_idis required when calling Get Pricing and Configuration - Inventory availability: Know which warehouses stock the product
Typical Workflow
- Call this endpoint to get available FOB points for a product
- Select the appropriate
fobIdbased on shipping destination - Use the
fobIdwhen calling Get Pricing and Configuration
Related Guides
- Get Pricing and Configuration - Use
fob_idto get pricing - Get Available Locations - Get decoration locations
- Get Available Charges - Get additional charges
- Get Decoration Colors - Get available decoration colors