Skip to content
Connectors
/
Platform Operators
/
Shopify
/
APIs
/
Synchronization Errors

Shopify Operator Connector APIs

General Notes

Authentication with OAuth 2.0

You must authenticate with a bearer token that can be generated from your Mirakl Platform back office. Refer to Generating Front API integration access tokens documentation page for more information.

Languages
Servers
Shopify production endpoint.

https://operator-shpy.mirakl.net/

Connection

Operations

Checkout

Operations

Synchronization Errors

Operations

GetOfferRecoverableError - Get an offer recoverable error

Request

Get a specific offer recoverable error that occurred during the synchronization process.

Call Frequency
Recommended usage:
- When you want to get a specific offer synchronization recoverable error

Query
discriminantstringrequired

The product sku: mp-7fe0b646-69bb-4ea5-8da9-fb5ecbeaf862

curl -i -X GET \
  'https://operator-shpy.mirakl.net/api/sync/mirakl-offers-sync-error?discriminant=string'

Responses

OK

Bodyapplication/json
attemptsinteger(int32)

Number of attempts made to process the error

Example: 3
dataobject

Additional data associated with the error

discriminantstring

Unique error discriminator

firstAttemptstring(date-time)

Timestamp of the first recorded attempt

Example: "2023-10-30T12:00:00Z"
lastAttemptstring(date-time)

Timestamp of the last attempt

Example: "2023-10-30T12:34:56Z"
lastErrorobject

Details of the last error

nextAttemptstring(date-time)

Timestamp for the next retry attempt

Example: "2023-10-31T00:00:00Z"
Response
application/json
{
  "attempts": 3,
  "data": "test",
  "discriminant": "mp-7fe0b646-69bb-4ea5-8da9-fb5ecbeaf862",
  "firstAttempt": "2023-10-30T12:00:00Z",
  "lastAttempt": "2023-10-30T12:34:56Z",
  "lastError": {
    "applicationCode": "CM19248",
    "httpCode": "404",
    "message": "Failed to synchronize offer"
  },
  "nextAttempt": "2023-10-31T00:00:00Z"
}

GetOrderPaymentTransactionRecoverableError - Get an order payment transaction recoverable error

Request

Get a specific order payment transaction recoverable error that occurred during the synchronization process.

Call Frequency
Recommended usage:
- When you want to get a specific order payment transaction synchronization recoverable error

Query
discriminantstringrequired

The Shopify order id: gid://shopify/Order/7133529014539

curl -i -X GET \
  'https://operator-shpy.mirakl.net/api/sync/mirakl-order-transactions-sync-error?discriminant=string'

Responses

OK

Bodyapplication/json
attemptsinteger(int32)

Number of attempts made to process the error

Example: 3
dataobject

Additional data associated with the error

discriminantstring

Unique error discriminator

firstAttemptstring(date-time)

Timestamp of the first recorded attempt

Example: "2023-10-30T12:00:00Z"
lastAttemptstring(date-time)

Timestamp of the last attempt

Example: "2023-10-30T12:34:56Z"
lastErrorobject

Details of the last error

nextAttemptstring(date-time)

Timestamp for the next retry attempt

Example: "2023-10-31T00:00:00Z"
Response
application/json
{
  "attempts": 3,
  "data": "test",
  "discriminant": "gid://shopify/Order/7133529014539",
  "firstAttempt": "2023-10-30T12:00:00Z",
  "lastAttempt": "2023-10-30T12:34:56Z",
  "lastError": {
    "applicationCode": "CM19248",
    "httpCode": "404",
    "message": "Failed to process order payment transaction"
  },
  "nextAttempt": "2023-10-31T00:00:00Z"
}

GetOrderRecoverableError - Get an order recoverable error

Request

Get a specific order recoverable error that occurred during the synchronization process.

Call Frequency
Recommended usage:
- When you want to get a specific order synchronization recoverable error

Query
discriminantstringrequired

The Shopify order id: gid://shopify/Order/7133529014539

curl -i -X GET \
  'https://operator-shpy.mirakl.net/api/sync/shopify-orders-sync-error?discriminant=string'

Responses

OK

Bodyapplication/json
attemptsinteger(int32)

Number of attempts made to process the error

Example: 3
dataobject

Additional data associated with the error

discriminantstring

Unique error discriminator

firstAttemptstring(date-time)

Timestamp of the first recorded attempt

Example: "2023-10-30T12:00:00Z"
lastAttemptstring(date-time)

Timestamp of the last attempt

Example: "2023-10-30T12:34:56Z"
lastErrorobject

Details of the last error

nextAttemptstring(date-time)

Timestamp for the next retry attempt

Example: "2023-10-31T00:00:00Z"
Response
application/json
{
  "attempts": 3,
  "data": "test",
  "discriminant": "gid://shopify/Order/7133529014539",
  "firstAttempt": "2023-10-30T12:00:00Z",
  "lastAttempt": "2023-10-30T12:34:56Z",
  "lastError": {
    "applicationCode": "CM19248",
    "httpCode": "404",
    "message": "Failed to synchronize order"
  },
  "nextAttempt": "2023-10-31T00:00:00Z"
}

GetProductRecoverableError - Get a product recoverable error

Request

Get a specific product recoverable error that occurred during the synchronization process.

Call Frequency
Recommended usage:
- When you want to get a specific product synchronization recoverable error

Query
discriminantstringrequired

The Shopify id of the product variant: gid://shopify/ProductVariant/51146999824651

curl -i -X GET \
  'https://operator-shpy.mirakl.net/api/sync/shopify-products-sync-error?discriminant=string'

Responses

OK

Bodyapplication/json
attemptsinteger(int32)

Number of attempts made to process the error

Example: 3
dataobject

Additional data associated with the error

discriminantstring

Unique error discriminator

firstAttemptstring(date-time)

Timestamp of the first recorded attempt

Example: "2023-10-30T12:00:00Z"
lastAttemptstring(date-time)

Timestamp of the last attempt

Example: "2023-10-30T12:34:56Z"
lastErrorobject

Details of the last error

nextAttemptstring(date-time)

Timestamp for the next retry attempt

Example: "2023-10-31T00:00:00Z"
Response
application/json
{
  "attempts": 3,
  "data": "test",
  "discriminant": "gid://shopify/ProductVariant/51146999824651",
  "firstAttempt": "2023-10-30T12:00:00Z",
  "lastAttempt": "2023-10-30T12:34:56Z",
  "lastError": {
    "applicationCode": "CM19248",
    "httpCode": "404",
    "message": "Category not synchronized with Mirakl"
  },
  "nextAttempt": "2023-10-31T00:00:00Z"
}

GetShipmentRecoverableError - Get a shipment recoverable error

Request

Get a specific shipment recoverable error that occurred during the synchronization process.

Call Frequency
Recommended usage:
- When you want to get a specific shipment synchronization recoverable error

Query
discriminantstringrequired

The Mirakl shipment id: d4dcfd38-2fa2-4380-80a7-2d7ff7e4d596

curl -i -X GET \
  'https://operator-shpy.mirakl.net/api/sync/mirakl-shipments-sync-error?discriminant=string'

Responses

OK

Bodyapplication/json
attemptsinteger(int32)

Number of attempts made to process the error

Example: 3
dataobject

Additional data associated with the error

discriminantstring

Unique error discriminator

firstAttemptstring(date-time)

Timestamp of the first recorded attempt

Example: "2023-10-30T12:00:00Z"
lastAttemptstring(date-time)

Timestamp of the last attempt

Example: "2023-10-30T12:34:56Z"
lastErrorobject

Details of the last error

nextAttemptstring(date-time)

Timestamp for the next retry attempt

Example: "2023-10-31T00:00:00Z"
Response
application/json
{
  "attempts": 3,
  "data": "test",
  "discriminant": "d4dcfd38-2fa2-4380-80a7-2d7ff7e4d596",
  "firstAttempt": "2023-10-30T12:00:00Z",
  "lastAttempt": "2023-10-30T12:34:56Z",
  "lastError": {
    "applicationCode": "CM19248",
    "httpCode": "404",
    "message": "Failed to synchronize shipment"
  },
  "nextAttempt": "2023-10-31T00:00:00Z"
}

ListOfferRecoverableErrors - List the offer recoverable errors

Request

List the offer recoverable errors that occurred during the synchronization process.
You can filter the list by page number and page size.

Call Frequency
Recommended usage:
- When you want to list the offer recoverable errors

Headers
PageNumberinteger(int32)>= 0required

The page number to retrieve

PageSizeinteger(int32)[ 1 .. 500 ]required

The number of items per page

curl -i -X GET \
  https://operator-shpy.mirakl.net/api/sync/mirakl-offers-sync-errors \
  -H 'PageNumber: 0' \
  -H 'PageSize: 1'

Responses

OK

Bodyapplication/json
recoverableErrorsArray of objects

List of recoverable error details

Response
application/json
{
  "recoverableErrors": [
    { … }
  ]
}

ListOrderPaymentTransactionRecoverableErrors - List the order payment transaction recoverable errors

Request

List the order payment transaction recoverable errors that occurred during the synchronization process.
You can filter the list by page number and page size.

Call Frequency
Recommended usage:
- When you want to list the order payment transaction recoverable errors

Headers
PageNumberinteger(int32)>= 0required

The page number to retrieve

PageSizeinteger(int32)[ 1 .. 500 ]required

The number of items per page

curl -i -X GET \
  https://operator-shpy.mirakl.net/api/sync/mirakl-order-transactions-sync-errors \
  -H 'PageNumber: 0' \
  -H 'PageSize: 1'

Responses

OK

Bodyapplication/json
recoverableErrorsArray of objects

List of recoverable error details

Response
application/json
{
  "recoverableErrors": [
    { … }
  ]
}

ListOrderRecoverableErrors - List the order recoverable errors

Request

List the order recoverable errors that occurred during the synchronization process.
You can filter the list by page number and page size.

Call Frequency
Recommended usage:
- When you want to list the order recoverable errors

Headers
PageNumberinteger(int32)>= 0required

The page number to retrieve

PageSizeinteger(int32)[ 1 .. 500 ]required

The number of items per page

curl -i -X GET \
  https://operator-shpy.mirakl.net/api/sync/shopify-orders-sync-errors \
  -H 'PageNumber: 0' \
  -H 'PageSize: 1'

Responses

OK

Bodyapplication/json
recoverableErrorsArray of objects

List of recoverable error details

Response
application/json
{
  "recoverableErrors": [
    { … }
  ]
}

ListProductRecoverableErrors - List the product recoverable errors

Request

List the product recoverable errors that occurred during the synchronization process.
You can filter the list by page number and page size.

Call Frequency
Recommended usage:
- When you want to list the product recoverable errors

Headers
PageNumberinteger(int32)>= 0required

The page number to retrieve

PageSizeinteger(int32)[ 1 .. 500 ]required

The number of items per page

curl -i -X GET \
  https://operator-shpy.mirakl.net/api/sync/shopify-products-sync-errors \
  -H 'PageNumber: 0' \
  -H 'PageSize: 1'

Responses

OK

Bodyapplication/json
recoverableErrorsArray of objects

List of recoverable error details

Response
application/json
{
  "recoverableErrors": [
    { … }
  ]
}

ListShipmentRecoverableErrors - List the shipment recoverable errors

Request

List the shipment recoverable errors that occurred during the synchronization process.
You can filter the list by page number and page size.

Call Frequency
Recommended usage:
- When you want to list the shipment recoverable errors

Headers
PageNumberinteger(int32)>= 0required

The page number to retrieve

PageSizeinteger(int32)[ 1 .. 500 ]required

The number of items per page

curl -i -X GET \
  https://operator-shpy.mirakl.net/api/sync/mirakl-shipments-sync-errors \
  -H 'PageNumber: 0' \
  -H 'PageSize: 1'

Responses

OK

Bodyapplication/json
recoverableErrorsArray of objects

List of recoverable error details

Response
application/json
{
  "recoverableErrors": [
    { … }
  ]
}

Storefront

Operations

Public

Operations

Settings

Operations

Setup

Operations

Synchronization

Operations