Skip to content

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/

Operations
Operations
Operations
Operations
Operations

GetShippingFees - Get shipping fees

Request

Using to display shipping methods per seller during the checkout process

Call Frequency

Bodyapplication/json
cart_linesArray of objectsrequired

A list of lines containing information about the items the customer intends to purchase

localestring

The locale of the customer. Must be an activated locale in Mirakl. (optional)

shipping_addressobject

The proposed customer shipping address. An address value is only present if delivery is required

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/public/shipping-fees \
  -H 'Content-Type: application/json' \
  -d '{
    "cartLines": [
      {
        "attributes": [
          {
            "key": "Shop name",
            "value": "* Super Shop"
          },
          {
            "key": "_mkp_offer_id",
            "value": "3090"
          },
          {
            "key": "_mkp_shipping_method_code",
            "value": "STD"
          }
        ],
        "cost": {
          "totalAmount": {
            "amount": 35,
            "currencyCode": "USD"
          }
        },
        "discountAllocations": [],
        "id": "gid://shopify/CartLine/f8483e37e89e6432c1ce004267e8683f",
        "lineComponents": [],
        "merchandise": {
          "id": "gid://shopify/ProductVariant/49202975801683",
          "image": {
            "altText": "",
            "url": "https://cdn.shopify.com/s/files/aa8ab4876d3d_256x256.jpg?v=1723551528"
          },
          "product": {
            "id": "gid://shopify/Product/9393674715475",
            "productType": "toys",
            "vendor": "Lego"
          },
          "requiresShipping": true,
          "selectedOptions": [
            {
              "name": "Title",
              "value": "Default Title"
            }
          ],
          "sku": "4654321654",
          "title": "LEGO Hero Factory - Furno Jet Machine",
          "type": "variant"
        },
        "quantity": 3
      },
      {
        "attributes": [
          {
            "key": "Shop name",
            "value": "* Super Shop"
          },
          {
            "key": "_mkp_offer_id",
            "value": "3092"
          },
          {
            "key": "_mkp_shipping_method_code",
            "value": "STD"
          }
        ],
        "cost": {
          "totalAmount": {
            "amount": 60,
            "currencyCode": "USD"
          }
        },
        "discountAllocations": [],
        "id": "gid://shopify/CartLine/f8483e37e89e6432c1ce004267e86840",
        "lineComponents": [],
        "merchandise": {
          "id": "gid://shopify/ProductVariant/49202975801684",
          "image": {
            "altText": "",
            "url": "https://cdn.shopify.com/s/files/aa8ab4854d3d_256x256.jpg?v=1723551528"
          },
          "product": {
            "id": "gid://shopify/Product/9393674715475",
            "productType": "accessories",
            "vendor": "Belkin"
          },
          "requiresShipping": true,
          "selectedOptions": [
            {
              "name": "Title",
              "value": "Default Title"
            }
          ],
          "sku": "9765435467",
          "title": "Belkin Auto Charger for iPhone and iPod",
          "type": "variant"
        },
        "quantity": 5
      },
      {
        "attributes": [
          {
            "key": "Shop name",
            "value": "Wag'\''s"
          },
          {
            "key": "_mkp_offer_id",
            "value": "3088"
          },
          {
            "key": "_mkp_shipping_method_code",
            "value": "NEX"
          }
        ],
        "cost": {
          "totalAmount": {
            "amount": 264,
            "currencyCode": "USD"
          }
        },
        "discountAllocations": [],
        "id": "gid://shopify/CartLine/f8483e37e89e6432c1ce004267e86841",
        "lineComponents": [],
        "merchandise": {
          "id": "gid://shopify/ProductVariant/49202975801685",
          "image": {
            "altText": "",
            "url": "https://cdn.shopify.com/s/files/a87ab4876d3d_256x256.jpg?v=1723551528"
          },
          "product": {
            "id": "gid://shopify/Product/9393674715475",
            "productType": "shoes",
            "vendor": "Pull"
          },
          "requiresShipping": true,
          "selectedOptions": [
            {
              "name": "Title",
              "value": "Default Title"
            }
          ],
          "sku": "9734842562",
          "title": "Pull-On Sneaker",
          "type": "variant"
        },
        "quantity": 1
      }
    ],
    "shippingAddress": {
      "address1": "47 Rue de Lubeck",
      "city": "Paris",
      "countryCode": "FR",
      "firstName": "Alexandre",
      "lastName": "Marie",
      "name": "Alexandre",
      "oneTimeUse": false,
      "phone": "",
      "zip": "75116"
    }
  }'

Responses

OK

Bodyapplication/json
errorsArray of objects

Errors

feesArray of objects

Seller fees

Response
application/json
{ "errors": null, "fees": [ {}, {} ] }
Operations
Operations
Operations