Skip to content

Create or update a store by its id in your system

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

Idempotent: the first call creates it, later calls with the same source and external id update the fields sent. References to other records can use their ids in the same source (…ExternalId). Stores are configuration: needs crm:configure.

Requires crm:configure.

productId
required
string
>= 1 characters <= 64 characters
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

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

externalId
required

The record’s id in that system.

string
>= 1 characters <= 128 characters

Example

C-1042

The record’s id in that system.

Media typeapplication/json
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
object
entity
required
string
id
required
string
>= 1 characters <= 64 characters
created
required

False when an existing record was updated (found by external id, or matched).

boolean
record
required
object
id
required
string
>= 1 characters <= 64 characters
name
required
string
platform
required
string
Allowed values: manual magento2 magento1
baseUrl
required
string | null
currency
required
string
createdAt
required
string
updatedAt
required
string
key
additional properties

Example

{
"record": {
"platform": "manual"
}
}

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