Skip to content
Shopgate Documentation
Search
Ctrl
K
Cancel
GitHub
A
A
A
Select theme
Dark
Light
Auto
Shopping Apps
Omnichannel Suite
For AI Agents
Omnichannel Suite
Intro
Guides
Catalog Integration
Integration Overview
Concepts and Entities
CSV Import
JSON Import
Catalog API Integration
Webhook Integration
Integration Overview
Available Webhooks
Notifications
Segmentation
Order Integration
Integration Overview
API Reference
Authentication
Batch Routes
Service URLs
Sorting and Filtering
Catalog
Overview
ParentCatalogs
Create new parent catalogs
Catalogs
Get catalogs
Create catalogs
Get catalog
Update catalog
Delete catalog
Properties
Get property definitions
Create property definitions
Get property definition
Update property definition
Delete property definition
Attributes
Get attributes
Create attributes
Get attribute
Update attribute
Delete attribute
Set attribute values
Update attribute value
Delete attribute value
Categories
Get categories
Create categories
Get category navigation tree
Update category
Delete category
Exports
Export entities as csv
Export entities to Google
Get exports
Get export settings
Set export settings
Get export settings key value
Products
Get products
Create products
Get product
Update product
Delete product
Get product descriptions
Get product reviews
Validate variant
Search
Search
Search
ProductLocationPrices
Get product location prices
Set product location prices
Delete product location prices
Inventories
Get inventories
Set inventories
Delete inventories
Increment / decrement inventory
Get location inventories
Get reservations
Reserve inventory
Delete inventory reservations
Settle reservations
Get reservation
Update reservation
Get product inventories
Get cumulated inventories
InventoryTreatmentSettings
Get inventory treatment settings
Create inventory treatment settings
Update inventory treatment setting
Delete inventory treatment setting
Schemas
All 140 models
AdditionResponse
Attribute
AttributeCode
AttributeCreate
AttributeName
AttributeType
AttributeUpdate
AttributeUse
AttributeValue
AttributeValueCode
AttributeValueCreate
AttributeValueName
AttributeValueSequenceId
AttributeValueUpdate
AttributeValueUpdateInList
AvailableFilter
BatchError
BatchErrors
Bin
BinLocation
CatalogBase
CatalogCreate
CatalogSettingsInput
CatalogSettingsOutput
CatalogUpdate
CategoriesMappingCreate
CategoriesResolved
Category
CategoryCreate
CategoryMapping
CategoryMappingCreate
CategoryTreeNode
CategoryUpdate
Code
CsvExportOptions
CurrencyCode
EndDate
EOLDate
Error
ErrorList
ErrorListObject
Event
ExportInput
ExportOutput
ExtendedError
ExternalUpdateDate
FirstAvailableDate
FulfillmentMethods
GoodType
GoodTypeUpdate
GoogleExport
GoogleExportFeed
GoogleExportOptions
GoogleExportStatus
HasCatchWeight
Inventory
InventoryCompare
InventoryExportInput
InventoryExportOutput
InventoryPost
InventoryTreatment
InventoryTreatmentSetting
InventoryTreatmentSettingCreate
InventoryTreatmentSettingUpdate
IsInventoryManaged
IsSerialized
IsTaxed
Localization
LocalizationDescription
LocalizationDescriptionLong
LocalizationMedia
LocalizationShort
LocalizationValue
LocationCode
LocationInventory
LocationInventoryExtended
LongNameResolved
MapPricing
MaxQty
Media
MediaResolved
MinQty
ModelType
NameResolved
NotFoundError
OptionalLocalization
OptionalLocalizationShort
Pagination
PaginationCursor
PaginationCursorOrOffset
ParentCatalogCreate
ParentCategoryCode
ParentProductCode
PickupLinkSettingsInput
PickupLinkSettingsOutput
Price
PriceGet
Product
ProductCode
ProductCreate
ProductExtras
ProductExtrasCreate
ProductIdentifiers
ProductLocationPrice
ProductLocationPriceCreate
ProductOptionAdditionalPrice
ProductOptions
ProductOptionsCreate
ProductProperties
ProductPropertiesCreate
ProductPropertyCreate
ProductUpdate
PropertiesResolved
PropertyCode
PropertyDefinition
PropertyDefinitionCreate
PropertyDefinitionType
PropertyDefinitionUpdate
Rating
Reservation
ReservationCreate
Review
ShippingInformation
StartDate
Status
Swatch
SyncWebhookCodes
SyncWebhookCreate
SyncWebhookFull
SyncWebhookStatus
SyncWebhookUpdate
TaxClass
Unit
UnitPriceRefUom
UnitPriceRefValue
UnitValue
Url
ValidationError
ValidationErrorResult
VolumePricing
Customer
Overview
Attributes
Get attributes
Create attributes
Get attribute
Update attribute
Delete attribute
Add attribute values
Update attribute value
Delete attribute value
Customers
Get customers
Create customers
Get customer
Update customer
Delete customer
Contacts
Add customer contacts
Update customer contact
Delete customer contact
Subscriptions
Get device subscriptions
Create device subscriptions
Delete device subscription
Get customer subscriptions
Create customer subscriptions
Delete customer subscription
Merge subscriptions
Schemas
All 67 models
AddAttribute
AddSubscription
AddWishlist
AssociatedShop
Attribute
AttributeCode
AttributeName
AttributeType
AttributeValue
AttributeValueCode
AttributeValueName
AttributeValueSequenceId
AttributeValueUpdateInList
BaseAttribute
BaseAttributeValue
BasicCustomer
BasicCustomerAttribute
BasicDevice
BasicDeviceAttribute
BasicWishlist
BatchErrors
ContactAdditionalFields
ContactCreate
ContactFull
ContactNoId
ContactSync
ContactUpdate
CreateCustomer
CursorPagination
Customer
CustomerAttribute
CustomerId
CustomerSettings
DeprovisioningRequest
Device
DeviceAttribute
Error
ErrorList
ErrorListObject
Event
Metrics
NotFoundError
Pagination
Password
SegmentCustomer
SegmentDevice
SegmentMember
SegmentMemberFull
SegmentMembers
SegmentMembersDelete
Status
Subscription
SyncWebhookCodes
SyncWebhookCreate
SyncWebhookFull
SyncWebhookStatus
SyncWebhookUpdate
UpdateAttribute
UpdateCustomer
UpdateDevice
UpdateWishlist
UpdateWishlistItem
ValidatedPassword
ValidationError
ValidationErrors
Wishlist
WishlistItem
Import
Overview
Import
Get imports
Create import
Trigger import
Get import logs
Get import log file
Get signed url
Schemas
All 13 models
ActionCounts
AdditionResponse
EntityFile
ErrorList
ErrorListObject
ForbiddenError
Import
NotFoundError
Pagination
SwaggerValidationError
ValidationError
ValidationErrorResult
ValidationErrors
Schemas
All 13 models
ActionCounts
AdditionResponse
EntityFile
ErrorList
ErrorListObject
ForbiddenError
Import
NotFoundError
Pagination
SwaggerValidationError
ValidationError
ValidationErrorResult
ValidationErrors
Order
Overview
SalesOrder
Get sales orders
Create sales orders
Get sales order
Update sales order
Get history of sales order
Create sales order checkout
Create sales order fulfillment groups
FulfillmentOrder
Get fulfillment orders
Create fulfillment orders
Get fulfillment order csv export
Update fulfillment orders status
Create simple fulfillment orders for order
Get fulfillment order
Update fulfillment order
Create fulfillments for fulfillment order
Update fulfillments of fulfillment order
Get history of fulfillment order
Update lineItem status of fulfillmentOrder
Picking Batch
Get picking batches
Create picking batches
Generate picking batch
Get picking batch
Update picking batch
Update picking batch line items
Delete fulfillmentOrder from picking batch
ReturnOrder
Get return orders
Create return orders
Get return order
Update return order
Schemas
All 130 models
AcceptDate
AddressAdditionalFields
AddressSequence
AppliedPromotions
AuthorizedAmount
BatchError
BatchErrors
CampaignAttribution
CancellationReason
CartId
CompleteDate
CreateDate
CreateFulfillment
CreateFulfillmentPackage
CreatePickingBatch
CreateProductCondition
CreateReturnReason
CurrencyCode
DimensionUnit
DiscountAmount
Domain
DropOffType
Error
ErrorList
ErrorListObject
ExtendedPrice
ExternalCode
ExternalCustomerNumber
FOFulfillmentPackageStatus
FOFulfillmentStatus
FOLineItem
FOOrderNumber
FulfillDate
Fulfillment
FulfillmentGroup
FulfillmentMethod
FulfillmentOrder
FulfillmentOrderAddress
FulfillmentOrderHistoryItem
FulfillmentOrderStatus
FulfillmentOrderType
FulfillmentPackage
FulfillmentSlot
GetOrders
GetPickingBatch
GetSalesOrder
HeldUntil
HistoryItem
Imported
LineItem
LineItemProduct
LineItemStatus
LocaleCode
LocaleCodeNormalized
LocalizationShort
Notes
OrderDiscountAmount
OrderPromoAmount
OS
PackageDimension
PackageItem
Pagination
PaymentTransaction
PaymentTransactionCode
PickingBatch
PickingBatchLineItem
PickingBatchStatus
PickupReminderApplicableAt
PlannedFulfillmentDate
Platform
PostCoupon
PostFOLineItem
PostFulfillmentGroup
PostFulfillmentOrder
PostFulfillmentOrderStatus
PostPackageItem
PosTransactionId
PostReturnOrder
PostROAddressSequence
PostROLineItem
PostSalesOrder
PostSimplifiedFulfillmentOrder
PostSOLineItem
ProductCondition
ProductIdentifiers
PromoAmount
QuantityChangeReason
ReadyDate
ReportingMetric
ReturnOrder
ReturnOrderStatus
ReturnOrderType
ReturnReason
ROAddressSequence
ROLineItem
ROLineItemStatus
RouteType
SalesOrder
SalesOrderHistoryItem
SalesOrderType
SelectedShippingMethod
SetAddressSequence
SetSelectedShippingMethod
ShippingMethod
ShippingServiceLevel
ShopCode
SimpleFulfillmentOrder
SimpleSalesOrder
SOFulfillment
SOLineItemStatus
SOLineItemSubStatus
SOStatus
SourceIP
SpecialInstructions
SubmitDate
Tax2Amount
TaxAmount
TaxSummary
UnitDiscountAmount
UnitPromoAmount
UpdateAddressSequence
UpdateFulfillment
UpdateFulfillmentPackage
UpdateReturnOrder
UpdateSalesOrder
UpdateSOLineItem
UserAgent
ValidationError
ValidationErrors
WeightUnit
Webhook
Overview
Webhooks
Get webhooks
Create webhooks
Get webhook events
Update webhook
Delete webhook
Test webhook
Get webhook token
Schemas
All 15 models
Code
ConflictError
DeprovisioningRequest
Error
ErrorList
ErrorListObject
Event
Ids
NotFoundError
ValidationError
ValidationErrorResult
WebhookCreate
WebhookFull
WebhookResponse
WebhookUpdate
Notification
Overview
Templates
/merchants/{merchantCode}/templates
/merchants/{merchantCode}/templates
/merchants/{merchantCode}/templates/{templateCode}
/merchants/{merchantCode}/templates/{templateCode}
/merchants/{merchantCode}/templates/{templateCode}
Campaigns
/merchants/{merchantCode}/campaigns
/merchants/{merchantCode}/campaigns
/merchants/{merchantCode}/campaigns/{campaignCode}
/merchants/{merchantCode}/campaigns/{campaignCode}
/merchants/{merchantCode}/campaigns/{campaignCode}
/merchants/{merchantCode}/campaigns/{campaignCode}/childCampaigns
Images
/merchants/{merchantCode}/images
Schemas
All 46 models
Action
ActionParameter
Actions
AdditionResponse
Campaign
CampaignDispatch
CampaignMetric
CampaignProcessingStatus
CampaignStatus
CampaignStatusGet
CampaignTriggerType
CreateCampaign
CreateTemplate
Delivery
DeliveryMethod
DeliveryMethods
Description
Error
ErrorList
ErrorListObject
EventSettings
EventType
LocalizedMessage
Message
NotFoundError
Pagination
ScheduleSettings
SegmentCode
SegmentCodes
SegmentRules
Template
TemplateCode
TemplateLocalizedMessage
TemplateMessage
TemplateName
TemplateStatus
TemplateTriggerType
TemplateWeightedMessage
Timezone
Tracking
TriggerConditions
UpdateCampaign
UpdateTemplate
ValidationError
ValidationErrorResult
WeightedMessage
GitHub
A
A
A
Select theme
Dark
Light
Auto
LocalizedMessage
Type:
object | null
