Ctrlk
Sign up for free
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Shipping Fees

List all shipping fees

get
Header parameters
Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Responses
200

List all shipping fees

application/json
NamestringOptional
CodestringOptional
AmountstringOptional
CurrencystringOptional
ApplyTostringOptional
TypestringOptional
get/shippingfees/
GET /rest/6.0/shippingfees/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

[
  {
    "Name": "shipping fee name #1",
    "Code": "4236A227D2",
    "Amount": "1.00",
    "Currency": "USD",
    "ApplyTo": "PRODUCT",
    "Type": "FIXED"
  },
  {
    "Name": "shipping fee name #2",
    "Code": "9366C227E7",
    "Amount": "0.00",
    "Currency": "EUR",
    "ApplyTo": "ORDER",
    "Type": "FIXED"
  }
]

Get shipping fee

get
Path parameters
ShippingFeeCodestringRequired

Unique code which represents a shipping fee

Example: 9366C227E7
Header parameters
Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Responses
200

Get shipping fee

application/json
NamestringOptional
CodestringOptional
AmountstringOptional
CurrencystringOptional
ApplyTostringOptional
TypestringOptional
get/shippingfees/{ShippingFeeCode}/
GET /rest/6.0/shippingfees/{ShippingFeeCode}/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

[
  {
    "Name": "shipping fee name #2",
    "Code": "9366C227E7",
    "Amount": "0.00",
    "Currency": "EUR",
    "ApplyTo": "ORDER",
    "Type": "FIXED"
  }
]

Search shipping methods

get
Query parameters
NamestringOptional

Shipping method name

Example: ShippingMethodName
Codesstring[]Optional

Shipping methods codes

Example: ["8902DDC4C3","3D4DD3B4A3"]
Countriesstring[]Optional

Shipping methods countries

Example: ["US","UK","AU"]
ActivebooleanOptional

Shipping method status

Example: true
PageintegerOptional

Page number

Example: 3
LimitintegerOptional

Number of results on a page

Example: 25
Header parameters
Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Responses
200

Shipping methods object

application/json
get/shippingmethods
GET /rest/6.0/shippingmethods HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "Items": [
    {
      "Name": "Shipping56",
      "Code": "3D4DD3B4A3",
      "TrackingUrl": "https://www.9230-kasdjx-a-z.com",
      "BasePrice": 23,
      "Currency": "USD",
      "Active": true,
      "Availability": "ALL",
      "Countries": [
        {
          "CountryCode": "AE",
          "Surcharge": "0"
        }
      ],
      "Surcharge": [
        {
          "Type": "WEIGHT",
          "From": 1.5,
          "To": -1,
          "Amount": 1,
          "ApplyTo": "unit"
        }
      ]
    }
  ],
  "Pagination": {
    "Page": 1,
    "Limit": 10,
    "Count": 12
  }
}

Retrieve shipping price

put
Header parameters
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Acceptstring · enumRequiredExample: application/jsonPossible values:
Body
CurrencystringOptional
Responses
200

OK

application/json
put/orders/0/shipping/
PUT /rest/6.0/orders/0/shipping/ HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 164

{
  "BillingDetails": {
    "CountryCode": "US"
  },
  "CouponCodes": [
    null
  ],
  "Currency": "USD",
  "DeliveryDetails": {
    "CountryCode": "US"
  },
  "Items": [
    {
      "Code": "tangible_code",
      "Quantity": 2
    }
  ]
}
[
  {
    "Code": "8A3AA7B463",
    "Currency": "USD",
    "Name": "US_Shipping_Method",
    "PriceDetails": {
      "Gross": {
        "BasePrice": 4,
        "CountrySurcharge": 2,
        "OrderSurcharge": 0,
        "OverweightAmount": 320,
        "TotalAmount": 336,
        "WeightSurcharge": 10
      },
      "Net": {
        "BasePrice": 4,
        "CountrySurcharge": 2,
        "OrderSurcharge": 0,
        "OverweightAmount": 320,
        "TotalAmount": 336,
        "WeightSurcharge": 10
      }
    },
    "TrackingUrl": ""
  }
]
PreviousPricing Configuration
NextSubscription

Last updated

Was this helpful?