API documentation Shortcodes

Contents

• List shortcodes
  • Attributes
  • Example
• Show shortcode
  • Attributes

List shortcodes

Provides the list of available and active shortcodes.

Endpoint

[GET] /v4/shortcodes/

Attributes

Key	Description	Datatype	Constraints/Remarks
shortcode	Shortcode	String

Example

Response

[
  "DE16515"
]

Show shortcode

Displays shortcode data

Endpoint

[POST] /v4/shortcodes/:shortcode

Attributes

Key	Description	Datatype	Constraints/Remarks
shortcode	Shortcode	String	Identifier
label_text	Label text	String	Text printed on labels
name1	Name1	String
name2	Name2	String
street	Street	String
city	City	String
zip	ZIP	String
country	Country	String	2 character ISO3166 country identifier
waybill_deliveries	Waybill delivery location can be used	Boolean
delivery_services	List of delivery services with availability	Map<String,Boolean>

Example: Show shortcode

Request

{
  "shortcode": "EHUB-AMS",
  "label_text": "NL - C",
  "name1": "VIAEUROPE BV",
  "name2": "IWS",
  "street": "PUDONGWEG 21",
  "city": "ROZENBURG",
  "zip": "1437EM",
  "country": "NL",
  "delivery_services": {
    "BEX": true,
    "BEX_UPS_BE": false,
    "DPD_AMZ": false,
    "DPD_BE_B2B": true,
    "THIRD_PARTY": false,
    "THIRD_PARTY_GB": false,
    "UPS_AMZ": false,
    "UPS_BE_MULTI": false,
    "UPS_NL_BULK": false,
    "TRACKING_ONLY": false,
    "AFTERSHIP_COMPATIBLE": false,
    "SEVENTEEN_TRACK_COMPATIBLE": false,
    "NO_COURIER": false
  },
  "waybill_deliveries": false
}