Skip to content

Create or update up to 100 records of any type in one call

POST
/products/{productId}/sync/batch
curl --request POST \
--url https://api.motenya.app/v1/products/example/sync/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "source": "erp", "records": [ { "entity": "store", "externalId": "C-1042", "data": { "name": "example", "currency": "RON", "baseUrl": "example", "platform": "manual" } } ] }'

Records are applied in order, each on its own: a failing record is rolled back and reported, and the rest still go through, so a record can name one sent earlier in the same batch. Use it to import history page by page. Store records need crm:configure.

Requires crm:write.

productId
required
string
>= 1 characters <= 64 characters
Media typeapplication/json
object
source
required

The system the record comes from, named by you: e.g. magento2:casa-verde, stripe, erp.

string
/^[a-z0-9][a-z0-9._:-]{0,63}$/

Example

erp
records
required

Applied in order, each on its own: a record can name one sent earlier in the batch.

Array
>= 1 items <= 100 items
One of:
object
entity
required
string
Allowed values: store
externalId
required

The record’s id in that system.

string
>= 1 characters <= 128 characters

Example

C-1042
data
required
object
name
string | null
>= 1 characters <= 100 characters
currency

ISO 4217 code, e.g. RON or EUR.

string | null
>= 3 characters <= 3 characters

Example

RON
baseUrl
string | null
<= 500 characters
platform
string | null
Allowed values: manual magento2 magento1

Success

Media typeapplication/json
Array<object>
object
index
required
integer
entity
required
string
externalId
required
string
ok
required
boolean
id
required
string | null
>= 1 characters <= 64 characters
created
required
boolean | null
userErrors
required
Array<object>
object
code
required
string
message
required
string
field
Array<string> | null
key
additional properties

Example generated

[
{
"index": 1,
"entity": "example",
"externalId": "example",
"ok": true,
"id": "example",
"created": true,
"userErrors": [
{
"code": "example",
"message": "example",
"field": [
"example"
]
}
]
}
]

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing, invalid, revoked or expired API key

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing scope, API turned off, published article without publish scope, or account suspended

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Not found, or outside the knowledge bases this key may use

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Slug or translation already exists

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rejected by validation (e.g. unknown language or category)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rate limited; see Retry-After

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Internal error