1WorldSync FetchProduct API
The FetchProduct API from 1WorldSync — 3 operation(s) for fetchproduct.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/1worldsync:1worldsync-fetchproduct-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: 1WorldSync Content1 Fetch Product API
description: '1WorldSync Content1 API
Content1 will provide access to accurate, trusted product data sourced directly from the Brand Owners through 1WorldSync’s APIs.'
contact:
url: http://support.1worldsync.com
email: 1ws-im-apps-build@syndigo.com
version: V1
servers:
- url: https://content1-api.1worldsync.com
description: Production Server
tags:
- name: FetchProduct
paths:
/V1/product/count:
post:
tags:
- FetchProduct
summary: This method will return product count for a given search criteria
description: This method will return product count for a given search criteria.
operationId: fetchItemCountByCriteria
parameters:
- name: appid
in: header
description: API User App Id
required: true
allowEmptyValue: false
schema:
type: string
example: ''
- name: hashcode
in: header
description: Hash of secret key, URL and timestamp
required: true
allowEmptyValue: false
schema:
type: string
example: hashcode
- name: timestamp
in: query
description: Current Timestamp in YYYY-MM-DDTHH:mm:ssZ format
required: true
allowEmptyValue: false
schema:
type: string
example: '2023-02-28T13:37:59Z'
- name: gln
in: header
description: Data requested for the GLNs (comma separated for multiple, no space required or Click the "Add Item" button)
required: false
allowEmptyValue: false
schema:
type: Array
example: ''
requestBody:
description: Criteria JSON
content:
application/json:
schema:
$ref: '#/components/schemas/ItemFetchRequest'
required: true
responses:
'500':
description: when error occurred in processing
content:
application/json:
schema:
$ref: '#/components/schemas/ItemFetchError'
'200':
description: will return count of products on a given criteria
content:
application/json:
schema:
$ref: '#/components/schemas/ItemCount'
'401':
description: For any Authorization, Authentication and validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ItemFetchError'
/V1/product/fetch:
post:
tags:
- FetchProduct
summary: This method will return list of products for a given search criteria
description: This method will search for products on a given search criteria and will return data in paged way. Page size can be mentioned in the request parameter. Using of "searchAfter" in request body will give you next page data.
operationId: fetchItemByCriteria
parameters:
- name: appid
in: header
description: API User App Id
required: true
allowEmptyValue: false
schema:
type: string
example: ''
- name: hashcode
in: header
description: Hash of secret key, URL and timestamp
required: true
allowEmptyValue: false
schema:
type: string
example: hashcode
- name: timestamp
in: query
description: Current Timestamp in YYYY-MM-DDTHH:mm:ssZ format
required: true
allowEmptyValue: false
schema:
type: string
example: '2023-02-28T13:37:59Z'
- name: pageSize
in: query
description: Page size, default to 1000
required: true
allowEmptyValue: false
schema:
maximum: 1000
type: integer
example: '1000'
- name: gln
in: header
description: Data requested for the GLNs (comma separated for multiple, no space required or Click the "Add Item" button)
required: false
allowEmptyValue: false
schema:
type: Array
example: ''
requestBody:
description: Criteria JSON
content:
application/json:
schema:
$ref: '#/components/schemas/ItemFetchRequest'
required: true
responses:
'500':
description: <p><ul><li>when page size is more then 1000</li><li>when error occurred in processing</li></ul></p>
content:
application/json:
schema:
$ref: '#/components/schemas/ItemFetchError'
'200':
description: 'Will return list of products. '
content:
application/json:
schema:
$ref: '#/components/schemas/ItemFetchResult'
'204':
description: When no products found.
'401':
description: For any Authorization, Authentication and validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ItemFetchError'
/V1/product/hierarchy:
post:
tags:
- FetchProduct
summary: Fetch item hierarchy details
description: This method will return item hierarchy details based on a given search criteria and will return data with pagination. Page size can be mentioned in the "size" parameter. Using of "searchAfter" in request body loads next page.
operationId: fetchHierarchiesByCriteria
parameters:
- name: appid
in: header
description: API User App Id
required: true
allowEmptyValue: false
schema:
type: string
example: ''
- name: hashcode
in: header
description: Hash of secret key, URL and timestamp
required: true
allowEmptyValue: false
schema:
type: string
example: hashcode
- name: timestamp
in: query
description: Current Timestamp in YYYY-MM-DDTHH:mm:ssZ format
required: true
allowEmptyValue: false
schema:
type: string
example: '2023-02-28T13:37:59Z'
- name: pageSize
in: query
description: Page size, default to 1000
required: true
allowEmptyValue: false
schema:
maximum: 1000
type: integer
example: '1000'
- name: gln
in: header
description: Data requested for the GLNs (comma separated for multiple, no space required or Click the "Add Item" button)
required: false
allowEmptyValue: false
schema:
type: Array
example: ''
requestBody:
description: Criteria JSON
content:
application/json:
schema:
$ref: '#/components/schemas/FetchHierarchyRequest'
required: true
responses:
'500':
description: <p><ul><li>Requested page size is grater than 1000</li><li>Internal error occured</li></ul></p>
content:
application/json:
schema:
$ref: '#/components/schemas/ItemFetchError'
'200':
description: Returns item hierarchy details.
content:
application/json:
schema:
$ref: '#/components/schemas/HierarchyFetchResult'
'401':
description: For any Authorization, Authentication and validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ItemFetchError'
components:
schemas:
Item:
type: object
properties:
objId:
type: string
description: Elasticsearch objId
example: '2334322'
gln:
type: string
description: Item shared with gln
example: 0838016005012
dataPoolType:
type: string
description: Item belongs to which data pool
example: SDP
item:
type: object
additionalProperties:
type: object
description: Item as map
example: {}
description: Item as map
example: {}
FetchHierarchyRequest:
type: object
properties:
gtin:
type:
- array
- 'null'
description: Item GTIN array
example: []
items:
type:
- string
- 'null'
description: Item GTIN array
example: '[]'
ipGln:
maxLength: 14
minLength: 14
type:
- string
- 'null'
description: Information Provider GLN
format: d{14}
example: 0838016005012
lastModifiedDate:
$ref: '#/components/schemas/LastModifiedDate'
sortFields:
uniqueItems: true
type:
- array
- 'null'
description: Fields that will be sorted upon
example:
- field: lastModifiedDate
desc: 'true'
- field: gtin
desc: 'false'
items:
$ref: '#/components/schemas/SortField'
searchAfter:
type:
- array
- 'null'
description: This field is used to fetch item in batch. To retrieve the next page of the items. You need to set searchAfter in search criteria from previous result.
example: []
items:
type:
- object
- 'null'
description: This field is used to fetch item in batch. To retrieve the next page of the items. You need to set searchAfter in search criteria from previous result.
example: []
description: Hierarchy search criteria
ItemCount:
type: object
properties:
count:
type: integer
description: This is total product count for given criteria.
format: int64
example: 1000
description: Product count result
ItemFetchRequest:
type: object
properties:
gtins:
type: array
items:
type: string
pullHierarchy:
type:
- boolean
- 'null'
description: Flag to indicate whether to include hierarchy in the response
example: false
gtin:
type:
- array
- 'null'
description: Item GTIN array
example: []
items:
type:
- string
- 'null'
description: Item GTIN array
example: '[]'
ipGln:
maxLength: 14
minLength: 14
type:
- string
- 'null'
description: Information Provider GLN
format: d{14}
example: 0838016005012
targetMarket:
maxLength: 3
minLength: 1
type:
- string
- 'null'
description: Target Market
example: US
lastModifiedDate:
$ref: '#/components/schemas/LastModifiedDate'
brandName:
type:
- string
- 'null'
description: Brand name (supports wildcard)
example: Brand Name
productType:
maxLength: 3
minLength: 1
type:
- string
- 'null'
description: Product Type
example: EA
isConsumerUnit:
type:
- string
- 'null'
description: Consumer Unit
example: 'false'
gpcCode:
type:
- string
- 'null'
description: GPC code or name (supports wildcard)
example: '10000248'
upcCode:
type:
- string
- 'null'
description: UPC code (supports wildcard)
example: '123456789128'
sortFields:
uniqueItems: true
type:
- array
- 'null'
description: Fields that will be sorted upon
example:
- field: lastModifiedDate
desc: 'true'
- field: gtin
desc: 'false'
items:
$ref: '#/components/schemas/SortField'
fields:
$ref: '#/components/schemas/FetchFields'
searchAfter:
type:
- array
- 'null'
description: This field is used to fetch item in batch. To retrieve the next page of the items. You need to set searchAfter in search criteria from previous result.
example: []
items:
type:
- object
- 'null'
description: This field is used to fetch item in batch. To retrieve the next page of the items. You need to set searchAfter in search criteria from previous result.
example: []
description: Product search criteria object
FetchFields:
type:
- object
- 'null'
properties:
include:
uniqueItems: true
type: array
description: 'To retrieve subset of attributes from item. Ex: ["gtin","informationProviderGLN","targetMarket","lastModifiedDate","brandName","gpcCategory","externalFileLink"]'
example: []
items:
type: string
description: 'To retrieve subset of attributes from item. Ex: ["gtin","informationProviderGLN","targetMarket","lastModifiedDate","brandName","gpcCategory","externalFileLink"]'
example: '[]'
exclude:
uniqueItems: true
type: array
description: 'To abandon some of attributes from item. Ex: ["*.gln","externalFileLink.authorizedRecipients"]'
example: []
items:
type: string
description: 'To abandon some of attributes from item. Ex: ["*.gln","externalFileLink.authorizedRecipients"]'
example: '[]'
description: Fields to be include or exclude in result; By default all fields will be included
ItemFetchHierarchy:
type: object
properties:
parentGtin:
type: string
gtin:
type: string
quantity:
type: string
children:
type: array
items:
$ref: '#/components/schemas/ItemFetchHierarchy'
description: Hierarchy mapping
LastModifiedDate:
type:
- object
- 'null'
properties:
from:
$ref: '#/components/schemas/DateField'
to:
$ref: '#/components/schemas/DateField'
description: Item last modified date
example:
from:
date: '2023-01-01'
op: GTE
to:
date: '2023-01-31'
op: LTE
SortField:
type:
- object
- 'null'
properties:
field:
type: string
description: 'Fields that will be sorted upon. Ex: gtin, informationProviderGLN and targetMarket etc.'
desc:
type: boolean
description: Fields that will be sorted upon
example:
- field: lastModifiedDate
desc: 'true'
- field: gtin
desc: 'false'
ItemFetchResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Item'
totalPages:
type: integer
description: This field used to set total page number for given search criteria.
format: int64
currentPage:
type: integer
description: This field used to set pagination page number.
format: int64
message:
type: string
description: This field used to set any warning message.
example: Warning message
totalCount:
type: integer
description: This field used to set total count.
format: int64
searchAfter:
type: array
description: This field is used to fetch item in batch. To retrieve the next page of the items. You need to set it in search criteria.
example: '[00637827872406,"US"]'
items:
type: object
description: This field is used to fetch item in batch. To retrieve the next page of the items. You need to set it in search criteria.
example: '[00637827872406,"US"]'
description: Product search result
HierarchyFetchResult:
type: object
properties:
hierarchies:
type: array
description: Hierarchies of the item.
items:
$ref: '#/components/schemas/HierarchyDetails'
message:
type: string
description: Response message.
example: To retrieve the next page of products, pick what you have received in searchAfter and set it in next request.
searchAfter:
type: array
description: This value is used to fetch next page of hierarchies.
example: '[00637827872406,"US"]'
items:
type: object
description: This value is used to fetch next page of hierarchies.
example: '[00637827872406,"US"]'
description: Hierarchy search result
ItemFetchError:
properties:
requestId:
type: string
description: An unique id generated at server end to track processing of this request
example: '12222'
code:
type: string
description: Error code
example: '[INTERNAL_SERVER_ERROR | REQUIRED_HEADER_APPID_MISSING]'
reason:
type: string
description: Error reason in human readable form
example: appId is missing
description: Error response object. you will receive this object when there is an error in server side in processing
example: '{"requestId":1334426,"code":"REQUIRED_HEADER_APPID_MISSING", "reason":"appId is missing in header" }'
HierarchyDetails:
type: object
properties:
gtin:
type: string
description: Item GTIN.
example: 03007687545289
informationProviderGLN:
type: string
description: Information provider GLN.
targetMarket:
type: string
description: Target market.
hierarchy:
type: array
description: Item hierarchy list.
items:
$ref: '#/components/schemas/ItemFetchHierarchy'
description: Item hierarchy details
DateField:
type: object
properties:
date:
type: string
description: Date
example: '2022-01-15T00:00:00'
op:
type: string
description: Date comparison operation type (ENUM)
example: GT
enum:
- GT
- GTE
- LT
- LTE
- EQ
description: LastModifiedDate To
x-provenance:
method: harvested
publisher: 1WorldSync
source: https://content1-api.1worldsync.com/v3/api-docs
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)