RoutiGolight-mode-imagedark-mode-image
Home
Terminology
    Powered by scalar.com
    Swagger Editor
    9
    1
    {"openapi":"3.0.1","info":{"title":"RoutiGo Upload REST API","description":"Allows uploading shipments into RoutiGo","contact":{"name":"RoutiGo Team","url":"https://www.routigo.com","email":"team@routigo.com"},"version":"1.0"},"servers":[{"url":"https://api.routigo.com/api"}],"tags":[{"name":"Import","description":"Import shipments"}],"paths":{"/v1/upload":{"put":{"tags":["Import"],"summary":"Upload a new set of shipments to the RoutiGo system","operationId":"processV1Upload","requestBody":{"description":"This API call can be used to register a new set of shipments in the RoutiGo system.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"}}}},"required":true},"responses":{"202":{"description":"The shipments have successfully registered within the system. Use the provided trackingId to track the processing of all items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingId"}}}}},"security":[{"apiKey":[]}]}}},"components":{"schemas":{"AddressDetails":{"required":["countryCode","houseNumber","postcode"],"type":"object","properties":{"houseNumber":{"type":"string","description":"Number of the building or house.","example":"8006"},"postcode":{"maxLength":8,"pattern":"^[A-Za-z0-9 ]{0,8}$","type":"string","description":"Postal code of the area. Postal code should be up to 8 characters, containing only letters, numbers, and spaces.","example":"3605 LT"},"countryCode":{"maxLength":2,"type":"string","description":"The country code of the location. Default `NL`. Described using: ISO 3166-1 alpha-2, Codes for the representation of countries.","example":"NL","default":"NL"},"name":{"type":"string","description":"The company name or name of the person living at the address.","example":"RoutiGo"},"streetName":{"type":"string","description":"Name of the street.","example":"Bisonspoor"},"houseNumberAddition":{"type":"string","description":"Additional information for the house number, if applicable (e.g., apartment number or building section).","example":"A"},"cityName":{"type":"string","description":"Name of the city or locality.","example":"Maarsen"},"geocodeLocation":{"$ref":"#/co