Skip to main content

Get eshop pickup places

GET 
/api/v1/pickup-place

Find all existing pickup places for an e-shop

Request​

Query Parameters

    eshopId stringrequired

    UUID of eshop

    page integer

    Default value: 0

    Zero-based page index (0..N)

    size integer

    Default value: 20

    The size of the page to be returned

    sort string[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses​

Pickup place (paged) collection successfully returned - may be empty

Schema

    items

    object[]

    Collection response wrapper

  • Array [

    • 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

  • ]

  • ]

    • page

    object

    nullable

    Information about the position in list

    totalPages int32

    Total pages

    totalElements int64

    Total elements

    size int32

    Number of elements per page

    number int32

    Current page number

    first boolean

    First page

    last boolean

    Last page

Loading...