# 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/_bundle/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3.yaml) ## Storefront ### CreateReturn - Create a return for an order - [POST /api/storefront/return](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/createreturn.md): Call Frequency Recommended usage: - When you want to create a return for an order ### GetEvaluationsAssessments - Get evaluations assessments - [GET /api/storefront/evaluations/assessments](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/getevaluationsassessments.md): Call Frequency Recommended usage: - When you want to retrieve the evaluations assessments ### GetItemsToReturn - Get items to return for a list of orders - [GET /api/storefront/returns/items-to-return](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/getitemstoreturn.md): Description When you want to retrieve items to return for a list of orders Call Frequency Recommended usage: - At each customer return request Maximum usage: - At each customer return request ### GetReturns - List returns - [GET /api/storefront/returns](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/getreturns.md): Call Frequency Recommended usage: - At each page display ### GetShipment - Get shipment details by Shopify fulfillment ID - [GET /api/storefront/shipment](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/getshipment.md): Description When you want to retrieve shipment details Call Frequency Recommended usage: - When you want to retrieve shipment details ### ListAccountingOrdersDocuments - List accounting orders documents - [GET /api/storefront/orders/accounting-documents](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/listaccountingordersdocuments.md): Description Retrieves a list of accounting documents for specified Mirakl orders, with secure URLs for downloading each document. ### ListOrdersDocuments - List orders documents - [GET /api/storefront/orders/documents](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/listordersdocuments.md): Description Retrieves a list of general order documents for specified Mirakl orders, with secure URLs for downloading each document. Call Frequency Recommended usage: - When you want to get documents for orders ### ListProductOffers - List offers for each given product - [GET /api/storefront/products/offers](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/storefront/listproductoffers.md): Description Calls the Mirakl P11 API and returns a trimmed payload tailored to the PDP. Call Frequency Recommended usage: - At each product page display Maximum usage: - At each product page display ### 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 Frequency Recommended usage: - When you want to display shop ratings Pagination This 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): Description For security reasons, not all fields are available depending on the context. For example, it is not possible to query the additional fields from the storefront. Call Frequency Recommended 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 Frequency Recommended 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 Frequency Recommended usage: - When you want to confirm the reception of a fulfillment to Mirakl ## Product Bindings ### DeleteProductBindings - Delete product bindings - [POST /api/product-bindings/delete](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/product-bindings/deleteproductbindings.md) ### ImportProductBindings - Import product bindings - [POST /api/product-bindings](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/product-bindings/importproductbindings.md) ### ListProductBindings - List product bindings - [GET /api/product-bindings](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/product-bindings/listproductbindings.md): Pagination This resource supports offset pagination (see documentation) ## 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 Frequency Recommended usage: - When you are required to read your environment configuration ### HardDeleteConnectionDev - Hard delete environment for dev/test only - [DELETE /api/environment-dev](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/connection/harddeleteconnectiondev.md) ## 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): Description Using to display the Mirakl shipment method during the checkout process Call Frequency Recommended 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): Description 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 ### 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): Description 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 ### 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): Description 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 ### GetReturnRecoverableError - Get a return recoverable error - [GET /api/sync/mirakl-returns-sync-error](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/getreturnrecoverableerror.md): Description Get a specific return recoverable error that occurred during the synchronization process. Call Frequency Recommended usage: - When you want to get a specific return 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): Description 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 ### GetShopRecoverableError - Get a shop recoverable error - [GET /api/sync/mirakl-shops-sync-error](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/getshoprecoverableerror.md): Description Get a specific shop recoverable error that occurred during the synchronization process. Call Frequency Recommended usage: - When you want to get a specific shop 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): Description List the offer recoverable errors that occurred during the synchronization process.You can filter the list by offset and max. Call Frequency Recommended usage: - When you want to list the offer recoverable errors Pagination This resource supports offset pagination (see documentation) ### 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): Description List the order recoverable errors that occurred during the synchronization process.You can filter the list by offset and max. Call Frequency Recommended usage: - When you want to list the order recoverable errors Pagination This resource supports offset pagination (see documentation) ### 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): Description List the product recoverable errors that occurred during the synchronization process.You can filter the list by offset and max. Call Frequency Recommended usage: - When you want to list the product recoverable errors Pagination This resource supports offset pagination (see documentation) ### ListReturnRecoverableErrors - List the return recoverable errors - [GET /api/sync/mirakl-returns-sync-errors](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/listreturnrecoverableerrors.md): Description List the return recoverable errors that occurred during the synchronization process.You can filter the list by offset and max. Call Frequency Recommended usage: - When you want to list the return recoverable errors Pagination This resource supports offset pagination (see documentation) ### 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): Description List the shipment recoverable errors that occurred during the synchronization process.You can filter the list by offset and max. Call Frequency Recommended usage: - When you want to list the shipment recoverable errors Pagination This resource supports offset pagination (see documentation) ### ListShopRecoverableErrors - List the shop recoverable errors - [GET /api/sync/mirakl-shops-sync-errors](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization-errors/listshoprecoverableerrors.md): Description List the shop recoverable errors that occurred during the synchronization process.You can filter the list by offset and max. Call Frequency Recommended usage: - When you want to list the shop recoverable errors Pagination This resource supports offset pagination (see documentation) ## Platform Settings ### GetOperatorReturnConfigurations - Get return configurations for shops - [GET /api/platform-settings/operator-return-configurations](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/platform-settings/getoperatorreturnconfigurations.md): Description When you want to retrieve return configurations for the operator Call Frequency Recommended usage: - When you want to retrieve return configurations for the operator ## 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): Description Using to display shipping methods per seller during the checkout process Call Frequency Recommended 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 Frequency Recommended usage: - When you are required to read your environment settings Read More More 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): Description Update your environment settings information field by field: unspecified fields will not be updated. Call Frequency Recommended usage: - When you are required to update the settings ## 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 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 Frequency Recommended usage: - When you need to check initialized data ### SetupCheckPermissions - Check Shopify permissions - [GET /api/setup/check-permissions](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/setup/setupcheckpermissions.md): Description Verify Shopify App has all the required permissions granted. Call Frequency Recommended usage: - When you need to check Shopify permissions ### 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): Description 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 Frequency Recommended 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): Description Synchronize categories and attributes from Shopify to Mirakl. This operation is asynchronous. Call Frequency Recommended usage: - When you are required to synchronize your taxonomy Maximum usage: - You can run only one taxonomy synchronization at a time ### SyncDeletedMiraklProducts - Synchronize deleted products from Mirakl to Shopify - [POST /api/sync/deleted-mirakl-products](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/syncdeletedmiraklproducts.md): Description Deletes third-party (3P) products from Shopify that have been deleted in Mirakl. This operation also cleans up the middleware by deleting the corresponding product bindings for both third-party (3P) and first-party (1P) products. The operation is asynchronous and scheduled to run periodically, so manual triggering is typically not required. Call Frequency Recommended usage: - Only when you need to trigger the synchronization manually. Maximum usage: - You can run only one Mirakl deleted products 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): Description Synchronize products from Shopify to Mirakl. This operation is asynchronous. Call Frequency Recommended usage: - When you are required to manually run the synchronization Maximum 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): Description Synchronizes offer conditions from Mirakl to Shopify. Call Frequency Recommended 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): Description 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 Frequency Recommended 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): Description Synchronize orders between Mirakl and Shopify. This operation is asynchronous. Call Frequency Recommended usage: - When you are required to synchronize your orders Maximum usage: - You can run only one order synchronization at a time ### SyncReturns - Synchronize returns from Mirakl to Shopify - [POST /api/sync/returns](https://developer.mirakl.com/content/connector/operator/shopify/app-operator-shopify/rest/public/openapi3/synchronization/syncreturns.md): Description Synchronizes returns from Mirakl to Shopify. This operation is asynchronous. Call Frequency Recommended usage: - When you want to synchronizes returns on demand Maximum usage: - You can run only one return 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): Description Synchronize shipments from Mirakl to Shopify. This operation is asynchronous. Call Frequency Recommended usage: - When you are required to synchronize your shipments Maximum 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): Description Synchronizes shops from Mirakl to Shopify. This operation is asynchronous. Call Frequency Recommended usage: - When you want to synchronizes shops on demand Maximum 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): Description 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 Frequency Recommended usage: - Only when you need to trigger the import manually. Maximum usage: - You can run only one product synchronization at a time