GuidesPPCGet FOB Points

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

ParameterTypeRequiredDescription
localization_countrystringNoCountry code (default: US)
localization_languagestringNoLanguage code (default: en)
environmentstringNoEnvironment: 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

FieldDescription
FobPointArrayArray of FOB (shipping origin) points
fobIdUnique identifier for the FOB point (used in pricing calls)
fobPostalCodePostal code of the warehouse
fobCityCity of the warehouse
fobStateState/province of the warehouse
fobCountryCountry of the warehouse
CurrencySupportedArrayCurrencies available at this location
ProductArrayProducts available at this FOB point

Use Cases

  • Shipping optimization: Choose the closest warehouse to reduce shipping costs
  • Pricing requests: fob_id is required when calling Get Pricing and Configuration
  • Inventory availability: Know which warehouses stock the product

Typical Workflow

  1. Call this endpoint to get available FOB points for a product
  2. Select the appropriate fobId based on shipping destination
  3. Use the fobId when calling Get Pricing and Configuration