Create new pickup place

POST 
/api/v1/pickup-place

Create new pickup place

Request

application/json

Body

required

eshopId uuidrequired

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

type DestinationType (string)required

Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

Type of destination

originPickupPlaceId stringrequired

Origin-specific id of the pickup place

name stringrequired

Name of the pickup place

location

object

required

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

line1 stringrequired

line2 string

city stringrequired

region string

state string

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

zipCode stringrequired

gps

object

required

latitude stringrequired

longitude stringrequired
countryCode CountryCode (string)required

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]

Location country of the pickup place

note string

Optional note on the pickup place

phone stringrequired

Pickup place phone

email stringrequired
storageTimeInDays int32required

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

to stringrequired

]

tuesday

object[]

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

Array [

from stringrequired

to stringrequired

]

wednesday

object[]

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

Array [

from stringrequired

to stringrequired

]

thursday

object[]

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

Array [

from stringrequired

to stringrequired

]

friday

object[]

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

Array [

from stringrequired

to stringrequired

]

saturday

object[]

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

Array [

from stringrequired

to stringrequired

]

sunday

object[]

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

Array [

from stringrequired

to stringrequired

]

exceptions

object[]

Array [

date stringrequired

hours

object[]

Array [

from stringrequired

to stringrequired

]

reason string

]

Responses

201

New pickup place successfully created

application/json

Schema

Schema

id uuidrequired

Identifier of pickup place

eshopId uuid

Id of the eshop this pickup place belongs to

type DestinationType (string)required

Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

Type of destination

carrier Carrier (string)required

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, 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, 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]

carrier identifier

originPickupPlaceId stringrequired

Origin ID of parcelShop/Box

origin OriginType (string)required

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

Type of origin system

countryCode CountryCode (string)required

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]

Location country of the pickup place

zoneId stringrequired
name stringrequired

location

object

required

Location of pickup place

line1 string

address line1

line2 string

address line2

city string

region string

optional address region

state string

optional address state

zipCode string

gps

object

GPS of pickup place location

latitude double

GPS latitude

longitude double

GPS longitude

note string
phone stringrequired

Customer phone

email stringrequired

email

image string

Pickup place image link

storageTime int32

How long the shipment will be stored, in days

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

to string

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

]

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

to string

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

]

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

to string

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

]

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

to string

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

]

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

to string

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

]

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

to string

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

]

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

to string

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

]

exceptions

object[]

required

Exceptional opening hours - e.g. public holidays

Array [

date date

from stringdeprecated

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

to stringdeprecated

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

hours

object[]

Array [

from string

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

to string

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

]

reason string

]

Example (from schema)

{
  "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"
      }
    ]
  }
}

application/problem+json

Schema

Schema

id uuidrequired

Identifier of pickup place

eshopId uuid

Id of the eshop this pickup place belongs to

type DestinationType (string)required

Possible values: [PARCEL_SHOP, PARCEL_BOX, HOUSE_ADDRESS]

Type of destination

carrier Carrier (string)required

Possible values: [BUDBEE, CZECH_POST, DHL, DIY, DPD, DPD_CZ, DPD_PL, DPD_SK, EU_SHIPMENTS, 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, 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]

carrier identifier

originPickupPlaceId stringrequired

Origin ID of parcelShop/Box

origin OriginType (string)required

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

Type of origin system

countryCode CountryCode (string)required

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]

Location country of the pickup place

zoneId stringrequired
name stringrequired

location

object

required

Location of pickup place

line1 string

address line1

line2 string

address line2

city string

region string

optional address region

state string

optional address state

zipCode string

gps

object

GPS of pickup place location

latitude double

GPS latitude

longitude double

GPS longitude

note string
phone stringrequired

Customer phone

email stringrequired

email

image string

Pickup place image link

storageTime int32

How long the shipment will be stored, in days

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

to string

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

]

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

to string

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

]

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

to string

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

]

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

to string

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

]

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

to string

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

]

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

to string

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

]

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

to string

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

]

exceptions

object[]

required

Exceptional opening hours - e.g. public holidays

Array [

date date

from stringdeprecated

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

to stringdeprecated

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

hours

object[]

Array [

from string

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

to string

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

]

reason string

]

Example (from schema)

{
  "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"
      }
    ]
  }
}

400

Input data validation error - constraint violation

application/problem+json

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

property name* object

Example (from schema)

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

401

Invalid API token

application/problem+json

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

property name* object

Example (from schema)

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

403

Access denied (under the current user account)

application/problem+json

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

property name* object

Example (from schema)

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

409

Conflict

*/*

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

property name* object

Example (from schema)

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

Loading...