Shipping

Introduction

Through the endpoints included in the Shipping section, you will be able to:

• Calculate shipping rate for a given country and variant with specified quantity

• Retrieve information about the shipping types

• Retrieve information about the shipping methods

• Retrieve a list of countries in our system

• Retrieve a list of regions in a specific country

Endpoints

Shipping rates

Calculate shipping rates

This API endpoint retrieves a list of calculated shipping rates for the given items and shipping info

POSThttps://api.merchone.com/api/beta/shipping/rates

Authorization

basicAuth

Body

application/json

shippingobject

itemsarray of ShippingItem (object)

Response

200401422

Request completed successfully.

Body

application/json

dataarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.merchone.com/api/beta/shipping/rates', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": [
    {
      "code": "DHL",
      "name": "DHL",
      "price": 6.02,
      "price_details": {
        "currency": "EUR",
        "formatted": "6.02 €",
        "in_subunit": 602
      }
    },
    {
      "code": "DHL",
      "name": "DHL",
      "price": 6.02,
      "price_details": {
        "currency": "EUR",
        "formatted": "6.02 €",
        "in_subunit": 602
      }
    }
  ]
}

Shipping types

Show shipping types

This API endpoint retrieves a list of all available shipping types

GEThttps://api.merchone.com/api/beta/shipping/types

Authorization

basicAuth

Response

200401

Request completed successfully.

Body

application/json

dataarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.merchone.com/api/beta/shipping/types', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "data": [
    {
      "priority": 1,
      "code": "UNTRACKED"
    },
    {
      "priority": 2,
      "code": "TRACKED"
    }
  ]
}

Shipping methods

Show shipping methods

This API endpoint retrieves a list of all available shipping methods

GEThttps://api.merchone.com/api/beta/shipping/methods

Authorization

basicAuth

Response

200401

Request completed successfully.

Body

application/json

dataarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.merchone.com/api/beta/shipping/methods', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "data": [
    {
      "code": "GEL",
      "name": "GEL"
    },
    {
      "code": "UPS",
      "name": "UPS"
    }
  ]
}

Countries

Show countries

This endpoint retrieves a list of countries with IDs and their corresponding codes.

GEThttps://api.merchone.com/api/beta/countries

Authorization

basicAuth

Response

200401

Request completed successfully.

Body

application/json

dataarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.merchone.com/api/beta/countries', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "Germany",
      "country_id": 276,
      "country_code": "DE"
    },
    {
      "name": "Latvia",
      "country_id": 428,
      "country_code": "LV"
    }
  ]
}

Regions

Show regions

This API endpoint retrieves the list of regions within a specific country by providing its ID.

GEThttps://api.merchone.com/api/beta/regions/{country_id}

Authorization

basicAuth

Path parameters

country_id*integer

ID of country from our system

Response

200400401

Request completed successfully.

Body

application/json

dataarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.merchone.com/api/beta/regions/{country_id}', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": 52,
      "code": "AB",
      "name": "Alberta"
    },
    {
      "id": 53,
      "code": "LB",
      "name": "Labrador"
    }
  ]
}

Parameters

Key	Description
shipping	An object that contains the country property.
shipping.country	The ID of the country from our system, check /api/beta/countries for more information about the countries.
items	An array of objects that contains information about the quantity and variant.
items.*.quantity	Quantity of a variant.
items.*.variant_id	The ID of the variant, please check /api/beta/products/{product_id} for more details about the variants.