Skip to main content
POST
/
stores
/
{storeId}
/
shipments
/
buy
Purchase Shipping Label
curl --request POST \
  --url https://api.getredo.com/v2.2/stores/{storeId}/shipments/buy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "carrier": {
    "id": "<string>"
  },
  "destination": {
    "address": {
      "city": "<string>",
      "country": "<string>",
      "line1": "<string>",
      "postalCode": "<string>",
      "state": "<string>",
      "line2": ""
    },
    "name": "<string>",
    "phoneNumber": "<string>"
  },
  "origin": {
    "address": {
      "city": "<string>",
      "country": "<string>",
      "line1": "<string>",
      "postalCode": "<string>",
      "state": "<string>",
      "line2": ""
    },
    "name": "<string>",
    "phoneNumber": "<string>"
  },
  "parcel": {
    "height": {
      "unit": "in",
      "value": 1
    },
    "length": {
      "unit": "in",
      "value": 1
    },
    "type": "box",
    "weight": {
      "unit": "g",
      "value": 1
    },
    "width": {
      "unit": "in",
      "value": 1
    }
  },
  "service": {
    "name": "<string>"
  }
}
'
{
  "shipment": {
    "documents": [
      {
        "type": "label"
      }
    ],
    "id": "<string>",
    "price": {
      "amount": "<string>",
      "currency": "<string>"
    },
    "tracker": {
      "code": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

storeId
string
required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Body

application/json
carrier
object
required
destination
Shipping Contact · object
required

Contact information for shipping.

origin
Shipping Contact · object
required

Contact information for shipping.

parcel
Parcel · object
required

Parcel information for shipping.

service
object
required

Response

Success

shipment
Shipment · object
required

Shipment information.