Skip to main content
POST
/
shops
/
{shopId}
/
delivery
/
rates
Create Delivery Rate
curl --request POST \
  --url http://staging.qshop.ng/apiv2/shops/{shopId}/delivery/rates \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "line_1": "<string>",
  "line_2": "<string>",
  "stateData": "<string>",
  "countryData": "<string>",
  "cityData": "<string>",
  "area": "<string>",
  "geoLocation": {
    "fullAddress": "<string>",
    "zipCode": "<string>",
    "coordinates": {
      "lng": 123,
      "lat": 123
    },
    "points": {
      "type": "<string>",
      "coordinates": [
        123
      ],
      "_id": "<string>"
    },
    "addressProximity": "<string>",
    "geoNames": [
      {
        "lng": "<string>",
        "geonameId": 123,
        "name": "<string>",
        "fclName": "<string>",
        "toponymName": "<string>",
        "fcodeName": "<string>",
        "adminName1": "<string>",
        "lat": "<string>",
        "fcl": "<string>",
        "fcode": "<string>",
        "population": 123,
        "adminCode1": "<string>",
        "countryId": "<string>",
        "countryCode": "<string>",
        "countryName": "<string>",
        "adminCodes1": {
          "ISO3166_2": "<string>"
        }
      }
    ],
    "google": {
      "address_components": [
        {
          "long_name": "<string>",
          "short_name": "<string>",
          "types": [
            "<string>"
          ]
        }
      ],
      "adr_address": "<string>",
      "formatted_address": "<string>",
      "geometry": {
        "location": {
          "lat": 123,
          "lng": 123
        },
        "viewport": {
          "south": 123,
          "west": 123,
          "north": 123,
          "east": 123
        }
      },
      "name": "<string>",
      "types": [
        "<string>"
      ],
      "utc_offset": 123,
      "html_attributions": "<array>",
      "utc_offset_minutes": 123
    },
    "_id": "<string>"
  },
  "isDefault": true,
  "_id": "<string>",
  "id": "<string>",
  "fullName": "<string>",
  "contact": {
    "telephone": "<string>",
    "email": "<string>"
  }
}
'
{
  "msg": "<string>",
  "data": {
    "recommended": {
      "id": "<string>",
      "_id": "<string>",
      "name": "<string>",
      "media": "<string>",
      "rateType": "<string>",
      "amount": 123,
      "serviceType": "<string>",
      "currency": "<string>",
      "estimatedDeliveryETA": "<string>",
      "estimatedPickupETA": "<string>",
      "estimatedDeliveryETADateTime": "<string>",
      "estimatedPickupETADateTime": "<string>",
      "description": "<string>",
      "courier": "<string>",
      "provider": "<string>",
      "type": "<string>",
      "platform": "<string>",
      "ratings": 123,
      "meta": {
        "courier_id": "<string>",
        "courier_name": "<string>",
        "courier_image": "<string>",
        "service_code": "<string>",
        "insurance": {
          "code": "<string>",
          "fee": 123
        },
        "discount": {
          "percentage": 123,
          "symbol": "<string>",
          "discounted": 123
        },
        "service_type": "<string>",
        "waybill": true,
        "is_cod_available": true,
        "tracking_level": 123,
        "ratings": 123,
        "votes": 123,
        "connected_account": true,
        "rate_card_amount": 123,
        "pickup_eta": "<string>",
        "pickup_eta_time": "<string>",
        "dropoff_station": "<unknown>",
        "pickup_station": "<unknown>",
        "delivery_eta": "<string>",
        "delivery_eta_time": "<string>",
        "info": [
          "<string>"
        ],
        "currency": "<string>",
        "vat": 123,
        "total": 123,
        "tracking": {
          "bars": 123,
          "label": "<string>"
        },
        "token": "<string>"
      },
      "preferenceStatus": "<string>",
      "actualAmount": 123,
      "markup": 123,
      "markupMeta": "<unknown>"
    },
    "providers": [
      {
        "id": "<string>",
        "_id": "<string>",
        "name": "<string>",
        "media": "<string>",
        "rateType": "<string>",
        "amount": 123,
        "serviceType": "<string>",
        "currency": "<string>",
        "estimatedDeliveryETA": "<string>",
        "estimatedPickupETA": "<string>",
        "estimatedDeliveryETADateTime": "<string>",
        "estimatedPickupETADateTime": "<string>",
        "description": "<string>",
        "courier": "<string>",
        "provider": "<string>",
        "type": "<string>",
        "platform": "<string>",
        "ratings": 123,
        "meta": {
          "courier_id": "<string>",
          "courier_name": "<string>",
          "courier_image": "<string>",
          "service_code": "<string>",
          "insurance": {
            "code": "<string>",
            "fee": 123
          },
          "discount": {
            "percentage": 123,
            "symbol": "<string>",
            "discounted": 123
          },
          "service_type": "<string>",
          "waybill": true,
          "is_cod_available": true,
          "tracking_level": 123,
          "ratings": 123,
          "votes": 123,
          "connected_account": true,
          "rate_card_amount": 123,
          "pickup_eta": "<string>",
          "pickup_eta_time": "<string>",
          "dropoff_station": "<unknown>",
          "pickup_station": "<unknown>",
          "delivery_eta": "<string>",
          "delivery_eta_time": "<string>",
          "info": [
            "<string>"
          ],
          "currency": "<string>",
          "vat": 123,
          "total": 123,
          "tracking": {
            "bars": 123,
            "label": "<string>"
          },
          "token": "<string>"
        },
        "preferenceStatus": "<string>",
        "actualAmount": 123,
        "markup": 123,
        "markupMeta": "<unknown>"
      }
    ]
  },
  "success": true
}

Path Parameters

shopId
string
required

Query Parameters

cart
string
type
string

Body

application/json
address
string
required
line_1
string
required
line_2
string
required
stateData
string
required
countryData
string
required
cityData
string
required
area
string
required
geoLocation
object
required
isDefault
boolean
required
_id
string
required
id
string
required
fullName
string
required
contact
object
required

Response

200 - application/json
msg
string
required
data
object
required
success
boolean
required