Skip to content
Connectors
/
Platform Operators
/
Shopify
/
APIs
/
Storefront
/
GetShipment - Get shipment details by Shopify fulfillment ID

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

Storefront

Operations

GetShipment - Get shipment details by Shopify fulfillment ID

Request

Call Frequency
Recommended usage:
- When you want to retrieve shipment details
Query
fulfillmentIdstringrequired

Shopify fulfillment identifier

curl -i -X GET \
  'https://operator-shpy.mirakl.net/api/storefront/shipment?fulfillmentId=string'

Responses

OK

Bodyapplication/json
canMarkAsReceivedbooleanrequired

Boolean indicating if the shipment can be marked as received

miraklShipmentIdstringrequired

The Mirakl shipment ID

shopifyFulfillmentIdstringrequired

The shopify fulfillment ID

statusstringrequired

The Mirakl status of the shipment

Response
application/json
{
  "canMarkAsReceived": true,
  "miraklShipmentId": "shipment-123",
  "shopifyFulfillmentId": "gid://shopify/Fulfillment/7175245005126",
  "status": "SHIPPED"
}

ListShopEvaluations - List evaluations of a shop

Request

Call Frequency
Recommended usage:
- When you want to display shop ratings
Pagination

This resource supports offset pagination (see documentation)

Path
shopIdstringrequired

Mirakl shop identifier

curl -i -X GET \
  'https://operator-shpy.mirakl.net/api/storefront/shop-ratings/{shopId}'

Responses

OK

Bodyapplication/json
evaluationsArray of objects

Evaluations list

totalCountinteger(int64)

Total count of elements returned by the query

Response
application/json
{
  "evaluations": [
    { … },
    { … },
    { … }
  ],
  "totalCount": 3
}

MiraklGraphQL - Forward request to Mirakl GraphQL API

Request

Call Frequency
Recommended usage:
- When you want to retrieve data from Mirakl GraphQL API
curl -i -X POST \
  https://operator-shpy.mirakl.net/api/storefront/graphql

Responses

OK

MiraklGraphQLUpload - Forward file upload request to Mirakl GraphQL Upload API

Request

Call Frequency
Recommended usage:
- When you want to upload files to Mirakl GraphQL API
curl -i -X PUT \
  https://operator-shpy.mirakl.net/api/storefront/graphql/upload

Responses

OK

ReceiveFulfillment - Confirm the reception of a fulfillment

Request

Call Frequency
Recommended usage:
- When you want tco confirm the reception of a fulfillment to Mirakl
Query
fulfillmentIdstringrequired

Shopify fulfillment identifier

curl -i -X PUT \
  'https://operator-shpy.mirakl.net/api/storefront/fulfillments/receive?fulfillmentId=string'

Responses

OK

Public

Operations

Settings

Operations

Setup

Operations

Synchronization

Operations