eComm Shipping Providers

Native Store Only

Shipping Provider Object

JSON

{
  "id": "string",
  "live_shipping_methods_url": "string",
  "test_shipping_methods_url": "string"
}

shipping_provider_info

Property	Type	Description
id	string	System identifier of the external shipping providers.
live_shipping_methods_url	string	Url that duda eCommerce's service will contact to retrieve the available shipping methods for a cart in live mode.
test_shipping_methods_url	string	Url that duda eCommerce's service will contact to retrieve the available shipping methods for a cart in test mode.

List Shipping Providers

List Shipping Providers

GET https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/shipping-rates/external

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier of the target site.

400: Bad Request

200: OK object

{
  "offset": 0,
  "limit": 0,
  "total_responses": 0,
  "results": [
    {
      "id": "string",
      "live_shipping_methods_url": "string",
      "test_shipping_methods_url": "string"
    }
  ]
}

curl

curl --request GET \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/shipping-rates/external \
     --header 'accept: application/json'

Create Shipping Providers

Create Shipping Providers

POST https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/shipping-rates/external

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site

Request Body

Name	Type	Description
live_shipping_rates_url*	string
test_shipping_rates_url	string

400: Bad Request

201: Created object

{
  "id": "string",
  "live_shipping_methods_url": "string",
  "test_shipping_methods_url": "string"
}

curl

curl --request POST \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/shipping-rates/external \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Get Shipping Provider

Get Shipping Provider

GET https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/shipping-rates/external/{id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
id*	string	The unique identifier for the target Shipping Rate.

200: OK object

{
  "id": "string",
  "live_shipping_methods_url": "string",
  "test_shipping_methods_url": "string"
}

400: Bad Request

curl

curl --request GET \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/shipping-rates/external/id \
     --header 'accept: application/json'

Update Shipping Provider

Update Shipping Provider

PATCH https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/shipping-rates/external/{id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
product_id*	string	The unique identifier for the target Shipping Rate.

Request Body

Name	Type	Description
live_shipping_rates_url*	string
test_shipping_rates_url	string

200: OK object

{
  "description": "The most amazing t shirt ever sold",
  "external_id": "KTP9XGbSg2",
  "id": "IakdKbiUiK",
  "images": [
    {
      "alt": "Image of fancy shirt",
      "url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
    }
  ],
  "name": "Amazing T-shirt",
  "options": [
    {
      "choices": [
        {
          "id": "db3je27rg7",
          "value": "45"
        }
      ],
      "id": "WMd1xylGrp",
      "name": "Shirt size"
    }
  ],
  "prices": [
    {
      "compare_at_price": "19.99",
      "currency": "USD",
      "price": "12.34"
    }
  ],
  "seo": {
    "description": "Amazing T-shirt made with 100% biologic cotton",
    "product_url": "amazing-t-shirt",
    "title": "Amazing T-shirt"
  },
  "sku": "UGG-BB-PUR-06",
  "status": "ACTIVE",
  "variations": [
    {
      "external_id": "KTP9XGbSg2",
      "id": "KTP9XGbSg2",
      "images": [
        {
          "alt": "Image of fancy shirt",
          "url": "https://images.pexels.com/photos/1020585/pexels-photo-1020585.jpeg"
        }
      ],
      "options": [
        {
          "choice_id": "db3je27rg7",
          "choice_value": "45",
          "option_id": "WMd1xylGrp",
          "option_name": "Shirt size"
        }
      ],
      "price_difference": "string",
      "quantity": 25,
      "sku": "UGG-BB-PUR-06",
      "status": "ACTIVE",
      "stock_status": "IN_STOCK, OUT_OF_STOCK"
    }
  ]
}

400: Bad Request

curl

curl --request PATCH \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/shipping-rates/external/id \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
    "live_shipping_rates_url": "string"
}
'

Delete Shipping Provider

Delete Shipping Provider

DELETE https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/shipping-rates/external/{id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
id*	string	The unique identifier for the target Shipping Rate.

204: No Content

400: Bad Request

curl

curl --request DELETE \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/shipping-rates/external/id \
     --header 'accept: application/json'