Resources & methods

The resources exposed by the SDK and their methods. See also Scope & versions.

Export	Endpoint	Methods
SpmShopConnection	shop/connection	saveConfiguration
SpmCustomers	customers	get · list · listGroups · save · update · bulkSave · bulkUpdate · delete · bulkDelete
SpmCustomersAddresses	customers/:id/addresses	list · save · update · bulkSave · bulkSaveAll · bulkUpdate · delete · bulkDelete
SpmCustomersGroups	customers-groups	list · CRUD · bulk
SpmProducts	products	list · CRUD · bulk
SpmProductsCategories	products-categories	list · CRUD · bulk
SpmProductsImages	products/:id/images	CRUD · bulk · bulkSaveAll
SpmProductsManufacturers	products-manufacturers	list · CRUD · bulk
SpmProductsVariations	products/:id/variations	CRUD · bulk · bulkSaveAll
SpmOrders	orders	get · getByReference · list · CRUD · bulk
SpmOrdersCarriers	orders-carriers	list · CRUD · bulk
SpmOrdersStatuses	orders-statuses	list · CRUD · bulk
SpmVouchers	vouchers	list · CRUD · bulk
SpmDataSources	data-sources	list · create · update · delete
SpmIntegrationConfig	integration-config	get · set — integrator-set config (per shop), resolved as {integration.<key>}
SpmCustomDataDefinitions	custom-data-definitions	list · get · create · update (= extend) · extend · activate · deactivate · delete · listOverrides · updateOverrides
SpmCustomDataRecords	custom-data-records/:definitionId	bulkSave (chunk 20) · list · update · delete · bulkDelete (chunk 20)
SpmContacts	contacts, contact-consent-history, contact-messages-reject	get · list · listLists · listTags · listCustomDataDefinitions · listConsentHistory · listMessagesReject
SpmEvents	events	create · update · list · listHistories · get · delete · trigger
SpmCarts	carts	list (read-only)
SpmLists	lists	list · get · create · update · delete · listContacts
SpmCustomKpi	custom-stats/kpis	list · get · listSources · listFields · create · update · delete · preview

Conventions

• CRUD = save / update (instance) + delete and their read counterparts where applicable.
• bulk = bulkSave / bulkUpdate / bulkDelete, with an optional { chunk: true }.
• bulkSaveAll = flat endpoint with the parent embedded in each item (nested resources).
• Read methods return the envelope; the payload is in res.data (often res.data.data for a single element).

label_source

label_source and id_data_source only apply to data synchronization resources (customers, products, orders, vouchers and their sub-resources) to track their origin. Other resources don't use them.

Helpers & validators

Export	Role
SpmHelpers	chunk, mergeResponses, extractCounts, isRetryable, formatError — see Resilience
SpmRequestValidator	Validate an incoming webhook — see Validate a webhook
SpmClient	Build the HTTP client
SpmClientException	Internal exception (rarely handled — the SDK does not throw)