Created with Sketch.
Created with Sketch.
Checkout 3.0

Partner Shipping

This section clarifies the process we use in our own Partner Shipping solution. It expands upon the Common Integration Process, offering more in-depth information specifically concerning Partner Shipping.

We designed this approach to empower you to develop and integrate your own tailor-made shipping broker with us, eliminating the need for an external provider.

However, if you prefer not to create a custom solution, there are external providers that integrate with our Partner Shipping API that you can opt for.

1. Sign agreement

If you are using an external provider, please contact them for further information.

2. Configure shipping broker

At this point, you’ve got two options. You can build your own shipping broker that works with our Partner Shipping solution. Or, if you prefer, you can use an external provider that’s already set up to work with Partner Shipping.

3. Activate shipping broker

Contact us and provide us with the necessary configuration details that you acquired from nShift in the previous steps. We will need:

  • Secret: a secret provided by you or the external provider. Every request from the specific Avarda checkout site to your / the external provider’s shipping broker API will include this value in the authorization header, employing the bearer scheme.
  • Fallback shipping text: any text of your choice that will be used in case shipping broker fails and can’t display the shipping widget.
  • Base URL: the base URL for your / the external provider’s shipping broker API.

We will then enable Partner Shipping in your checkout form.

4. Extend API requests

See example of a fully extended request below:

{
  "items": [
    {
      "description": "Product One",
      "notes": "Some notes",
      "amount": 50,
      "taxCode": "tax46",
      "taxAmount": 2,
      "quantity": 1,
      "articleNumber": "ASDASD86",
      // Extended shipping parameters ↓
      "shippingParameters": {
          "height": 300,
          "length": 300,
          "width": 30,
          "weight": 30,
          "attributes": [
              "Hazmat"
          ]
      }
    },
    // Extended default shipping item ↓
    {
        "Description": "Shipping",
        "Notes": "SHI001",
        "Amount": 55.0,
        "TaxCode": "0",
        "TaxAmount": 9.8,
        "Quantity": 1
    }
  ],
  // Extended shipping settings ↓
  "shippingSettings": {
    "Vouchers": [
        "value"
    ],
    "attributes": [
        "isbulky=True",
        "shippingclass=A"
    ]
  }
}

Default shipping item

View Default Shipping Item section in the Common Integration Guide for more information.

Shipping parameters

The shipping parameters are specific for a single item. This is extra information your shipping broker can use for several reasons depending on the implementation.  
View Shipping Parameters section in the Common Integration Guide for more information.

ParameterTypeNecessityDescription
heightIntegerOptionalHeight of the item in millimeters
lengthIntegerOptionalLength of the item in millimeters
widthIntegerOptionalWidth of the item in millimeters
weightIntegerOptionalWeight of the item in grams
attributesstring[]OptionalAttributes of the item, use case depends on your shipping broker implementation.
These values are passed “as is” to your shipping broker.

Shipping settings

The shipping settings affect the entire cart. This is extra information your shipping broker can use for several reasons depending on the implementation. 
View Shipping Settings section in the Common Integration Guide for more information.

ParameterTypeNecessityDescription
vouchersstring[]OptionalVouchers, use case depends on your shipping broker implementation.
These values are passed “as is” to your shipping broker.
attributesstring[]OptionalAttributes of the entire cart, use case depends on your shipping broker implementation.
These values are passed “as is” to your shipping broker.

5. Obtain shipping details

After a purchase is successfully completed, the Payment Status response will include additional shipping data withi­n the “modules” section, encompassing all essential shipping information.