Get a product
The product’s details in a locale; its variants, sources and sales have their own operations.
GET
The product’s details in a locale; its variants, sources and sales have their own operations.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringFormat
uuidlocale?stringContent locale; the workspace default without one
Length
length <= 35OK
application/json- response
id*stringFormat
uuidstoreId*stringFormat
uuidexternalId*stringlocale*stringtitle*string|nullmissing*array<>published*booleanhandle*string|nullstatus*stringValue in
"active""unlisted""draft""archived""removed"removedAt*|Format
date-timevendor*string|nullproductType*string|nullimage*|nullprice*|nullcompareAtPrice*variantCount*integerstock*stringValue in
"in_stock""out_of_stock""not_tracked"inventory*integer|nullchangedAt*|Format
date-timestore*locales*array<string>description*string|nulllink*|Format
uriadminUrl*|Format
uritags*array<string>customFields*publishedAt*|Format
date-timecreatedAt*|Format
date-timeaddedAt*stringFormat
date-timesyncedAt*stringFormat
date-timecurl -X GET 'https://api.postforge.dev/v1/products/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c", "externalId": "string", "locale": "string", "title": "string", "missing": [ "title" ], "published": true, "handle": "string", "status": "active", "removedAt": "2019-08-24T14:15:22Z", "vendor": "string", "productType": "string", "image": { "url": "http://example.com", "alt": "string" }, "price": { "min": { "amount": 0, "currency": "str" }, "max": { "amount": 0, "currency": "str" } }, "compareAtPrice": { "amount": 0, "currency": "str" }, "variantCount": 0, "stock": "in_stock", "inventory": 0, "changedAt": "2019-08-24T14:15:22Z", "store": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "platform": "string" }, "locales": [ "string" ], "description": "string", "link": "http://example.com", "adminUrl": "http://example.com", "tags": [ "string" ], "customFields": { "property1": "string", "property2": "string" }, "publishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "addedAt": "2019-08-24T14:15:22Z", "syncedAt": "2019-08-24T14:15:22Z"}