Logo
Try our API
POST/shops

Create Shop

This endpoint is used to create a shop with pickup/drop details.
POST/shops

Important Notes

  • horizon must contain either:
    • Only numbers: "1", "2-5", "1,2-5", etc.
    • Or only dates in:
      • "YYYY/MM/DD"
      • "YYYY/MM/DD-YYYY/MM/DD"
      • "YYYY/MM/DD-YYYY/MM/DD,YYYY/MM/DD"
    • Mixing numbers and dates is not allowed.
  • horizonDow (if provided) specifies days of the week:
    • 0 – Sunday
    • 1 – Monday
    • 2 – Tuesday
    • 3 – Wednesday
    • 4 – Thursday
    • 5 – Friday
    • 6 – Saturday
    • Example: [1, 2, 3] for Monday, Tuesday, Wednesday
  • pickupTime and dropTime must be in HH:MM format (24-hour clock).

Example Request:

{
  "shopName": "Fast Rentals",
  "markets": [
    {
      "pickupLocation": "AAR",
      "dropLocation": "FMM"
    },
    {
      "pickupLocation": "FMM",
      "dropLocation": "AAR"
    }
  ],
  "websiteCode": [1],
  "cob": "US",
  "lor": 1,
  "currency": "USD",
  "horizon": "1-60",
  "horizonDow": [1],
  "pickupTime": "10:30",
  "dropTime": "10:30"
}

Parameter Details

NameInTypeRequiredDescription
» shopNamebodystringRequiredCustom name for the shop.
» marketsbodyRequirednone
»» pickupLocationbodystringRequiredPickup location.
»» dropLocationbodystringRequiredDrop location
» websiteCodebody[integer]Requirednone
» cobbodystringRequiredCountry of booking details.
» lorbodyintegerRequiredLength of rent details.
» currencybodystringRequiredCurrency code (e.g., USD, EUR).
» horizonbodystringRequiredNumber of days (if not using start and end dates).
» horizonDowbody[integer]Optionalnone
» pickupTimebodyRequiredPickup time of the trip.
» dropTimebodyRequiredDrop time of the trip.

Responses

StatusMeaningDescriptionSchema
201CreatedCreated
400Bad RequestBad RequestNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbidden - Access deniedNone
429Too Many RequestsToo Many RequestsNone
500Internal Server ErrorInternal Server ErrorNone

Example Request

# You can also use wget
curl -X POST /shops \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -d '{"shopName":"string","markets":"string","»pickupLocation":"string","»dropLocation":"string","websiteCode":"string","cob":"string","lor":0,"currency":"string","horizon":"string","horizonDow":"string","pickupTime":"string","dropTime":"string"}'

Body parameter

{
  "shopName": "My Shop",
  "markets": [
    {
      "pickupLocation": "AXD",
      "dropLocation": "AYT"
    }
  ],
  "websiteCode": [
    1
  ],
  "cob": "US",
  "lor": 1,
  "currency": "USD",
  "horizon": 30,
  "horizonDow": [],
  "pickupTime": "10:30",
  "dropTime": "10:30"
}

Example responses

201 Response
{
  "message": "Shop created successfully",
  "shopId": 1
}
PreviousGet Location Status
NextList Shops

Need Support?

Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.

Contact Support