Authentication
Service URLs
Sorting, Filtering and Fields
Batch Routes
Attributes
Catalogs
Categories
Inventories
Exports
ParentCatalogs
Products
Models
Import
Models
Webhooks
Models

Service URLs

Service Subdomains

Every retail.red service is reachable under its own subdomain, using the following format: https://{serviceName}.shopgate.io.

Examples

  • https://location.shopgate.io
  • https://order.shopgate.io

Service Paths

All service paths follow the REST pattern and are scoped by entities. All entities are scoped by merchant, and therefore start with the merchant entity:

/v${version}/merchants/{merchantCode}/${subentityName}/[${subentityID}]

Examples:

  • https://location.shopgate.io/v1/merchants/TEST/locations
  • https://catalog.shopgate.io/v1/merchants/TEST/products/awesomeProductCode