# Shopify Operator Connector APIs

{% partial file="/partial-content/connector/operator/shopify/app-operator-shopify/rest/public/openapi-description.md" /%}


## Servers

Shopify production endpoint.
```
https://operator-shpy.mirakl.net
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Shopify Operator Connector APIs](https://developer.mirakl.com/_spec/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3.yaml)

## Connection

### GetConnection - Get the information of the connection between a Shopify store an a Mirakl instance

 - [GET /api/environment](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/connection/getconnection.md): Call FrequencyRecommended usage: - When you are required to read your environment configuration

## Checkout

### GetCustomCarrierRates - Get Mirakl custom carrier information

 - [POST /api/storefront/custom-carrier](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/checkout/getcustomcarrierrates.md): Using to display the Mirakl shipment method during the checkout processCall FrequencyRecommended usage: - Each time we need to compute the Mirakl shipping fees during the checkout

## Synchronization Errors

### GetOfferRecoverableError - Get an offer recoverable error

 - [GET /api/sync/mirakl-offers-sync-error](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/getofferrecoverableerror.md): Get a specific offer recoverable error that occurred during the synchronization process.Call FrequencyRecommended usage: - When you want to get a specific offer synchronization recoverable error

### GetOrderPaymentTransactionRecoverableError - Get an order payment transaction recoverable error

 - [GET /api/sync/mirakl-order-transactions-sync-error](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/getorderpaymenttransactionrecoverableerror.md): Get a specific order payment transaction recoverable error that occurred during the synchronization process.Call FrequencyRecommended usage: - When you want to get a specific order payment transaction synchronization recoverable error

### GetOrderRecoverableError - Get an order recoverable error

 - [GET /api/sync/shopify-orders-sync-error](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/getorderrecoverableerror.md): Get a specific order recoverable error that occurred during the synchronization process.Call FrequencyRecommended usage: - When you want to get a specific order synchronization recoverable error

### GetProductRecoverableError - Get a product recoverable error

 - [GET /api/sync/shopify-products-sync-error](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/getproductrecoverableerror.md): Get a specific product recoverable error that occurred during the synchronization process.Call FrequencyRecommended usage: - When you want to get a specific product synchronization recoverable error

### GetShipmentRecoverableError - Get a shipment recoverable error

 - [GET /api/sync/mirakl-shipments-sync-error](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/getshipmentrecoverableerror.md): Get a specific shipment recoverable error that occurred during the synchronization process.Call FrequencyRecommended usage: - When you want to get a specific shipment synchronization recoverable error

### ListOfferRecoverableErrors - List the offer recoverable errors

 - [GET /api/sync/mirakl-offers-sync-errors](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/listofferrecoverableerrors.md): List the offer recoverable errors that occurred during the synchronization process.You can filter the list by page number and page size.Call FrequencyRecommended usage: - When you want to list the offer recoverable errors

### ListOrderPaymentTransactionRecoverableErrors - List the order payment transaction recoverable errors

 - [GET /api/sync/mirakl-order-transactions-sync-errors](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/listorderpaymenttransactionrecoverableerrors.md): 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 FrequencyRecommended usage: - When you want to list the order payment transaction recoverable errors

### ListOrderRecoverableErrors - List the order recoverable errors

 - [GET /api/sync/shopify-orders-sync-errors](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/listorderrecoverableerrors.md): List the order recoverable errors that occurred during the synchronization process.You can filter the list by page number and page size.Call FrequencyRecommended usage: - When you want to list the order recoverable errors

### ListProductRecoverableErrors - List the product recoverable errors

 - [GET /api/sync/shopify-products-sync-errors](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/listproductrecoverableerrors.md): List the product recoverable errors that occurred during the synchronization process.You can filter the list by page number and page size.Call FrequencyRecommended usage: - When you want to list the product recoverable errors

### ListShipmentRecoverableErrors - List the shipment recoverable errors

 - [GET /api/sync/mirakl-shipments-sync-errors](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/listshipmentrecoverableerrors.md): List the shipment recoverable errors that occurred during the synchronization process.You can filter the list by page number and page size.Call FrequencyRecommended usage: - When you want to list the shipment recoverable errors

## Public

### GetShippingFees - Get shipping fees

 - [POST /api/public/shipping-fees](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/public/getshippingfees.md): Using to display shipping methods per seller during the checkout processCall FrequencyRecommended usage: - Each display of the shipping method selection in checkout

## Settings

### ListSettings - List connector settings

 - [GET /api/settings](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/settings/listsettings.md): Call FrequencyRecommended usage: - When you are required to read your environment settingsRead MoreMore context (shopify middleware setting)

### UpdateSettings - Update connector settings

 - [PATCH /api/settings](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/settings/updatesettings.md): Update your environment settings information field by field: unspecified fields will not be updated.Call FrequencyRecommended usage: - When you are required to update the settings

## Storefront

### ListShopEvaluations - List evaluations of a shop

 - [GET /api/storefront/shop-ratings/{shopId}](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/listshopevaluations.md): Call FrequencyRecommended usage: - When you want to display shop ratingsPaginationThis resource supports offset pagination (see documentation)

### MiraklGraphQL - Forward request to Mirakl GraphQL API

 - [POST /api/storefront/graphql](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/miraklgraphql.md): Call FrequencyRecommended usage: - When you want to retrieve data from Mirakl GraphQL API

### MiraklGraphQLUpload - Forward file upload request to Mirakl GraphQL Upload API

 - [PUT /api/storefront/graphql/upload](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/miraklgraphqlupload.md): Call FrequencyRecommended usage: - When you want to upload files to Mirakl GraphQL API

### ReceiveFulfillment - Confirm the reception of a fulfillment

 - [PUT /api/storefront/fulfillments/receive](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/receivefulfillment.md): Call FrequencyRecommended usage: - When you want tco confirm the reception of a fulfillment to Mirakl

## Setup

### SetupCheckConsistency - Check initialized data

 - [GET /api/setup/check-consistency](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/setup/setupcheckconsistency.md): Description: Verifies whether the data initialized during the application's installation is still up to date. It compares the currently used data with the initial or expected version and returns an update status indicator. This ensures data consistency and helps detect potential refresh needs.Call FrequencyRecommended usage: - When you need to check initialized data

### SetupUpdate - Update initialized data

 - [POST /api/setup/update](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/setup/setupupdate.md): Updates all the data that was initialized during the application's installation. It ensures that the latest versions of the required data are applied, maintaining consistency and preventing outdated information from affecting the system's functionality.Call FrequencyRecommended usage: - When you need to update initialized data

## Synchronization

### SyncCatalogStructure - Synchronize your Shopify catalog structure to Mirakl

 - [POST /api/sync/taxonomy](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/synccatalogstructure.md): Synchronize categories and attributes from Shopify to Mirakl. This operation is asynchronous.Call FrequencyRecommended usage: - When you are required to synchronize your taxonomyMaximum usage: - You can run only one taxonomy synchronization at a time

### SyncFirstPartyProducts - Synchronize first-party products from Shopify to Mirakl

 - [POST /api/sync/product-shopify-to-mirakl](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/syncfirstpartyproducts.md): Synchronize products from Shopify to Mirakl. This operation is asynchronous.Call FrequencyRecommended usage: - When you are required to manually run the synchronizationMaximum usage: - You can run only one synchronization at a time

### SyncOfferConditions - Synchronize offer conditions from Mirakl to Shopify

 - [POST /api/sync/offer-conditions](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/syncofferconditions.md): Synchronizes offer conditions from Mirakl to Shopify.Call FrequencyRecommended usage: - When you need to synchronize offer conditions

### SyncOffers - Sync Offers

 - [POST /api/sync/offers](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/syncoffers.md): Import offers from Mirakl into Shopify. This operation is asynchronous and is scheduled to run periodically, so in most cases, you don't need to trigger it manually.Call FrequencyRecommended usage: - Only when you need to trigger the import manually.Maximum usage: - You can run only one offer synchronization at a time

### SyncOrders - Synchronize orders between Mirakl and Shopify

 - [POST /api/sync/orders](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/syncorders.md): Synchronize orders between Mirakl and Shopify. This operation is asynchronous.Call FrequencyRecommended usage: - When you are required to synchronize your ordersMaximum usage: - You can run only one order synchronization at a time

### SyncShipments - Synchronize shipments from Mirakl to Shopify

 - [POST /api/sync/shipment-mirakl-to-shopify](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/syncshipments.md): Synchronize shipments from Mirakl to Shopify. This operation is asynchronous.Call FrequencyRecommended usage: - When you are required to synchronize your shipmentsMaximum usage: - You can run only one shipment synchronization at a time

### SyncShops - Synchronize shops from Mirakl to Shopify

 - [POST /api/sync/shops](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/syncshops.md): Synchronizes shops from Mirakl to Shopify. This operation is asynchronous.Call FrequencyRecommended usage: - When you want to synchronizes shops on demandMaximum usage: - You can run only one shop synchronization at a time

### SyncThirdPartyProducts - Synchronize third-party products from Mirakl to Shopify

 - [POST /api/sync/product-mirakl-to-shopify](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/syncthirdpartyproducts.md): Import products from Mirakl into Shopify. This operation is asynchronous and is scheduled to run periodically, so in most cases, you don't need to trigger it manually.Call FrequencyRecommended usage: - Only when you need to trigger the import manually.Maximum usage: - You can run only one product synchronization at a time