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

GetCustomCarrierRates - Get Mirakl custom carrier information

Request

Using to display the Mirakl shipment method during the checkout process

Call Frequency

Bodyapplication/json
rateobject

Shipping rate request

curl -i -X POST \
  https://operator-shpy.mirakl.net/api/storefront/custom-carrier \
  -H 'Content-Type: application/json' \
  -d '{
    "rate": {
      "currency": "USD",
      "destination": {
        "address1": "47 Rue de Lubeck",
        "address2": null,
        "address3": null,
        "address_type": null,
        "city": "Paris",
        "company_name": "Mirakl",
        "country": "FR",
        "email": "contact@Mirakl.com",
        "fax": null,
        "latitude": 48.8640412,
        "longitude": 2.2903055,
        "name": "Corporate Headquarters",
        "phone": "0172316200",
        "postal_code": "75116",
        "province": null
      },
      "items": [
        {
          "fulfillment_service": "manual",
          "grams": "0",
          "name": "LEGO Hero Factory - Furno Jet Machine",
          "price": 3500,
          "properties": {
            "Shop name": "* Super Shop",
            "_mkp_offer_id": "3090",
            "_mkp_shipping_method_code": "STD"
          },
          "quantity": "3",
          "requires_shipping": true,
          "sku": "4654321654",
          "taxable": true,
          "vendor": "Lego"
        },
        {
          "fulfillment_service": "manual",
          "grams": "0",
          "name": "Belkin Auto Charger for iPhone and iPod",
          "price": 60,
          "properties": {
            "Shop name": "* Super Shop",
            "_mkp_offer_id": "3092",
            "_mkp_shipping_method_code": "STD"
          },
          "quantity": "5",
          "requires_shipping": true,
          "sku": "9765435467",
          "taxable": true,
          "vendor": "Belkin"
        },
        {
          "fulfillment_service": "manual",
          "grams": "0",
          "name": "Pull-On Sneaker",
          "price": 264,
          "properties": {
            "Shop name": "Wag'\''s",
            "_mkp_offer_id": "3088",
            "_mkp_shipping_method_code": "NEX"
          },
          "quantity": "1",
          "requires_shipping": true,
          "sku": "9734842562",
          "taxable": true,
          "vendor": "Lego"
        }
      ],
      "locale": "en-US",
      "origin": {
        "address1": "",
        "address2": "",
        "address3": "",
        "address_type": "",
        "city": "",
        "company_name": "",
        "country": "FR",
        "email": "",
        "fax": "",
        "latitude": null,
        "longitude": null,
        "name": "",
        "phone": "",
        "postal_code": "",
        "province": ""
      }
    }
  }'

Responses

OK

Bodyapplication/json
ratesArray of objects

Shipping rates response

Response
application/json
{ "rates": [ { … } ] }
Operations
Operations
Operations
Operations
Operations
Operations