Create new pickup place

POST /api/v1/pickup-place

Request

application/json

Body

required

eshopId uuidrequired

Id of the eshop this pickup place belongs to - required if originType != CARRIER

Example: 12345678-1234-1234-1234-1234567890ab

type DestinationType (string)required

Type of destination

Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

Example: HOUSE_ADDRESS

originPickupPlaceId stringrequired

Origin-specific id of the pickup place

Example: 123456789

name stringrequired

Name of the pickup place

Example: Pobocka Karlin

location

object

required

Location (address) of the pickup place - except for country

line1 stringrequired

Example: Krizikova 70

line2 string

city stringrequired

Example: Praha 8

region string

state string

State name - applicable for countries such as the US, Canada, etc.

Example: California

zipCode stringrequired

Example: 158 00

gps

object

required

latitude stringrequired

longitude stringrequired

countryCode CountryCode (string)required

Location country of the pickup place

Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

Example: CZ

note string

Optional note on the pickup place

Example: This pickup place is a really nice place

phone stringrequired

Pickup place phone

Example: +420 987 654 321

email stringrequired

Example: karlin@mybriliantcompany.com

storageTimeInDays int32required

Example: 3

openingHours

object

required

Opening hours of the pickup place

regular

object

required

monday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from stringrequired

Example: 09:00

to stringrequired

Example: 17:00

]

tuesday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from stringrequired

Example: 09:00

to stringrequired

Example: 17:00

]

wednesday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from stringrequired

Example: 09:00

to stringrequired

Example: 17:00

]

thursday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from stringrequired

Example: 09:00

to stringrequired

Example: 17:00

]

friday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from stringrequired

Example: 09:00

to stringrequired

Example: 17:00

]

saturday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from stringrequired

Example: 09:00

to stringrequired

Example: 17:00

]

sunday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from stringrequired

Example: 09:00

to stringrequired

Example: 17:00

]

exceptions

object[]

Array [

date stringrequired

Example: 2024-10-28

hours

object[]

Array [

from stringrequired

Example: 09:00

to stringrequired

Example: 17:00

]

reason string

Example: Public holidays

]

Responses

New pickup place successfully created

application/json
application/problem+json

Schema
Example (from schema)

Schema

id uuidrequired

Identifier of pickup place

eshopId uuid

Id of the eshop this pickup place belongs to

Example: edf4b2ec-c1fc-42da-ba86-eb3a236cd565

type DestinationType (string)required

Type of destination

Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

Example: HOUSE_ADDRESS

carrier Carrier (string)required

carrier identifier

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, FAN_COURIER, FEDEX, GEBRUDER_WEISS, GEIS, GLS, GLS_CZ, GLS_HR, GLS_HU, GLS_RO, GLS_SI, GLS_SK, GO_BALIK, INPOST, JAPO, KURIER_123, KURYR_123, LANDMARK, MESSENGER, PACKETA, PBH, POST_AG, POCZTA_POLSKA, PPL, PPL_CPL, SAMEDAY, SAMEDAY_RO, SLOVAKIA_POST, SPEEDY, SPRING_GDS, SPS, SWISS_POST, TAXYDROMIKI, TOP_TRANS, ULOZENKA, URGENT_CARGUS, UNKNOWN, UPS, WEDO, PERSONAL_PICKUP]

Example: GLS

originPickupPlaceId stringrequired

Origin ID of parcelShop/Box

Example: FZ001

origin OriginType (string)required

Type of origin system

Possible values: [CARRIER, SHOPTET, SHOPTET_PREMIUM, SHOPIFY, UPGATES, API_USER]

Example: SHOPTET

countryCode CountryCode (string)required

Location country of the pickup place

Example: CZ

zoneId stringrequired

Example: America/New_York

name stringrequired

Example: My cool pickup place

location

object

required

Location of pickup place

line1 string

address line1

Example: Sesame street 11b

line2 string

address line2

city string

Example: MyCoolCity

region string

optional address region

Example: Michigan

state string

optional address state

Example: Michigan

zipCode string

Example: 48228

gps

object

GPS of pickup place location

latitude double

GPS latitude

Example: 14.4542789

longitude double

GPS longitude

Example: 50.0933864

note string

Example: Amazing place

phone stringrequired

Customer phone

Example: +420 123 456 789

email stringrequired

Example: iboughtsomething@customer.com

image string

Pickup place image link

Example: https://cdn.images/amazing.png

storageTime int32

How long the shipment will be stored, in days

Example: 4

openingHours

object

required

Opening Hours and exceptions

regular

object

required

Regular opening hours

monday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

tuesday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

wednesday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

thursday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

friday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

saturday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

sunday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

exceptions

object[]

required

Exceptional opening hours - e.g. public holidays

Array [

date date

Example: 2023-02-17

from stringdeprecated

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to stringdeprecated

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

hours

object[]

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

reason string

Example: Reconstruction

]

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "eshopId": "edf4b2ec-c1fc-42da-ba86-eb3a236cd565",
  "type": "HOUSE_ADDRESS",
  "carrier": "GLS",
  "originPickupPlaceId": "FZ001",
  "origin": "SHOPTET",
  "countryCode": "CZ",
  "zoneId": "America/New_York",
  "name": "My cool pickup place",
  "location": {
    "line1": "Sesame street 11b",
    "line2": "string",
    "city": "MyCoolCity",
    "region": "Michigan",
    "state": "Michigan",
    "zipCode": "48228",
    "gps": {
      "latitude": 14.4542789,
      "longitude": 50.0933864
    }
  },
  "note": "Amazing place",
  "phone": "+420 123 456 789",
  "email": "iboughtsomething@customer.com",
  "image": "https://cdn.images/amazing.png",
  "storageTime": 4,
  "openingHours": {
    "regular": {
      "monday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "tuesday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "wednesday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "thursday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "friday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "saturday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "sunday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ]
    },
    "exceptions": [
      {
        "date": "2023-02-17",
        "hours": [
          {
            "from": "08:00:00",
            "to": "18:00:00"
          }
        ],
        "reason": "Reconstruction"
      }
    ]
  }
}

Schema
Example (from schema)

Schema

id uuidrequired

Identifier of pickup place

eshopId uuid

Id of the eshop this pickup place belongs to

Example: edf4b2ec-c1fc-42da-ba86-eb3a236cd565

type DestinationType (string)required

Type of destination

Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

Example: HOUSE_ADDRESS

carrier Carrier (string)required

carrier identifier

Example: GLS

originPickupPlaceId stringrequired

Origin ID of parcelShop/Box

Example: FZ001

origin OriginType (string)required

Type of origin system

Possible values: [CARRIER, SHOPTET, SHOPTET_PREMIUM, SHOPIFY, UPGATES, API_USER]

Example: SHOPTET

countryCode CountryCode (string)required

Location country of the pickup place

Example: CZ

zoneId stringrequired

Example: America/New_York

name stringrequired

Example: My cool pickup place

location

object

required

Location of pickup place

line1 string

address line1

Example: Sesame street 11b

line2 string

address line2

city string

Example: MyCoolCity

region string

optional address region

Example: Michigan

state string

optional address state

Example: Michigan

zipCode string

Example: 48228

gps

object

GPS of pickup place location

latitude double

GPS latitude

Example: 14.4542789

longitude double

GPS longitude

Example: 50.0933864

note string

Example: Amazing place

phone stringrequired

Customer phone

Example: +420 123 456 789

email stringrequired

Example: iboughtsomething@customer.com

image string

Pickup place image link

Example: https://cdn.images/amazing.png

storageTime int32

How long the shipment will be stored, in days

Example: 4

openingHours

object

required

Opening Hours and exceptions

regular

object

required

Regular opening hours

monday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

tuesday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

wednesday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

thursday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

friday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

saturday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

sunday

object[]

Time interval(s) during the day when the place is open - null or empty means closed all day

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

exceptions

object[]

required

Exceptional opening hours - e.g. public holidays

Array [

date date

Example: 2023-02-17

from stringdeprecated

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to stringdeprecated

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

hours

object[]

Array [

from string

Possible values: Value must match regular expression HH:mm:ss

Example: 08:00:00

to string

Possible values: Value must match regular expression HH:mm:ss

Example: 18:00:00

]

reason string

Example: Reconstruction

]

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "eshopId": "edf4b2ec-c1fc-42da-ba86-eb3a236cd565",
  "type": "HOUSE_ADDRESS",
  "carrier": "GLS",
  "originPickupPlaceId": "FZ001",
  "origin": "SHOPTET",
  "countryCode": "CZ",
  "zoneId": "America/New_York",
  "name": "My cool pickup place",
  "location": {
    "line1": "Sesame street 11b",
    "line2": "string",
    "city": "MyCoolCity",
    "region": "Michigan",
    "state": "Michigan",
    "zipCode": "48228",
    "gps": {
      "latitude": 14.4542789,
      "longitude": 50.0933864
    }
  },
  "note": "Amazing place",
  "phone": "+420 123 456 789",
  "email": "iboughtsomething@customer.com",
  "image": "https://cdn.images/amazing.png",
  "storageTime": 4,
  "openingHours": {
    "regular": {
      "monday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "tuesday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "wednesday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "thursday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "friday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "saturday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ],
      "sunday": [
        {
          "from": "08:00:00",
          "to": "18:00:00"
        }
      ]
    },
    "exceptions": [
      {
        "date": "2023-02-17",
        "hours": [
          {
            "from": "08:00:00",
            "to": "18:00:00"
          }
        ],
        "reason": "Reconstruction"
      }
    ]
  }
}

Input data validation error - constraint violation

application/problem+json

Schema
Example (from schema)

Schema

type uri

title string

status int32

detail string

instance uri

properties

object

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

Invalid API token

application/problem+json

Schema
Example (from schema)

Schema

type uri

title string

status int32

detail string

instance uri

properties

object

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

Access denied (under the current user account)

application/problem+json

Schema
Example (from schema)

Schema

type uri

title string

status int32

detail string

instance uri

properties

object

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

Conflict

Schema
Example (from schema)

Schema

type uri

title string

status int32

detail string

instance uri

properties

object

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

Create new pickup place

/api/v1/pickup-place

Request​

Body

Responses​

Request

Responses