{"openapi":"3.0.0","info":{"version":"1.0.0","title":"ParcelSync API","description":"This ParcelSync API aims to enhance data communication throughout the logistics cycle, from order placement to final delivery, by enabling order data sending, tracking data retrieval, shipment data retrieval, label retrieval, and waybill retrieval.","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://api2.parcelsync.io/"}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"key"}}},"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/status":{"get":{"summary":"Get the status of the API","description":"Get the status of the API","tags":["Status"],"responses":{"200":{"description":"The status of the API","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The status of the API"},"project":{"type":"string","description":"The project ID"}}}}}}}}},"/v1/shipment":{"post":{"summary":"Create a shipment","description":"Create a shipment","tags":["Shipment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"carrier":{"type":"string"},"carrierService":{"type":"string","nullable":true},"reference":{"type":"string"},"note":{"type":"string","nullable":true},"seller":{"type":"string","nullable":true},"recipient":{"type":"object","properties":{"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"phone":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"houseNumber":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"pickupPoint":{"type":"string","nullable":true}},"additionalProperties":false},"parcels":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"number","format":"float"},"width":{"type":"number","format":"float"},"height":{"type":"number","format":"float"},"length":{"type":"number","format":"float"},"referenceNumber":{"type":"string"}},"required":["weight","width","height","length","referenceNumber"],"additionalProperties":false}},"payment":{"type":"object","properties":{"amount":{"type":"number","format":"float"},"currency":{"type":"string"},"type":{"type":"string","enum":["prepaid","cashondelivery"]},"paymentReference":{"type":"string"}},"required":["amount","currency","type"],"additionalProperties":false},"insurance":{"type":"object","properties":{"value":{"type":"number","format":"float"},"currency":{"type":"string"}},"required":["value","currency"],"additionalProperties":false},"customs":{"type":"object","properties":{"description":{"type":"string"},"totalValue":{"type":"number","format":"float"},"currency":{"type":"string"},"commodities":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"title":{"type":"string"},"quantity":{"type":"number","format":"float"},"hsCode":{"type":"string"},"weight":{"type":"number","format":"float"},"originCountry":{"type":"string"},"value":{"type":"number","format":"float"},"currency":{"type":"string"}},"required":["sku","title","quantity","hsCode","weight","originCountry","value","currency"],"additionalProperties":false}}},"required":["description","totalValue","currency"],"additionalProperties":false,"nullable":true},"carrierOptions":{"type":"object","properties":{},"additionalProperties":false,"nullable":true}},"required":["carrier","reference","recipient","parcels","payment"],"additionalProperties":false}}}},"responses":{"200":{"description":"The shipment","content":{"application/json":{"schema":{"type":"object","properties":{"carrier":{"type":"string","description":"The carrier","example":"PACKETA"},"carrierService":{"type":"object","description":"The carrier service"},"reference":{"type":"string","description":"The reference of the shipment","example":"123456789"},"note":{"type":"string","description":"The note of the shipment","example":"This is a note"},"recipient":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the contact person","example":"John"},"lastName":{"type":"string","description":"The last name of the contact person","example":"Doe"},"companyName":{"type":"string","description":"The company name","example":"ParcelSync"},"email":{"type":"string","description":"The email address","example":"j.doe@parcelsync.io"},"phone":{"type":"string","description":"The phone number","example":"+420 123 456 789"},"street":{"type":"string","description":"The street name","example":"Main Street"},"houseNumber":{"type":"string","description":"The house number","example":"123"},"city":{"type":"string","description":"The city","example":"Prague"},"country":{"type":"string","description":"The country","example":"CZ"},"postalCode":{"type":"string","description":"The postal code","example":"12345"},"pickupPoint":{"type":"string","description":"The pickup point","example":"ParcelShop"}}},"parcels":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"number","description":"The weight of the parcel in kilograms","example":1.5},"width":{"type":"number","description":"The width of the parcel in centimeters","example":10},"height":{"type":"number","description":"The height of the parcel in centimeters","example":10},"length":{"type":"number","description":"The length of the parcel in centimeters","example":10},"referenceNumber":{"type":"string","description":"The reference number of the parcel","example":"123456789"},"trackingNumber":{"type":"string","description":"The tracking number of the parcel","example":"123456789"}}}},"payment":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the payment","example":100},"currency":{"type":"string","description":"The currency of the payment","example":"CZK"},"type":{"type":"string","description":"The type of the payment","enum":["prepaid","cashondelivery"],"example":"prepaid"},"paymentReference":{"type":"string","description":"The payment reference","example":"123456789"}}},"insurance":{"type":"object","properties":{"value":{"type":"number","description":"The value of the insured parcel","example":100},"currency":{"type":"string","description":"The currency of the insured parcel","example":"CZK"}}},"customs":{"type":"object","properties":{"description":{"type":"string","description":"The description of the customs","example":"Customs description"},"totalValue":{"type":"number","description":"The total value of the customs","example":100},"currency":{"type":"string","description":"The currency of the customs","example":"CZK"},"commodities":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the commodity","example":"SKU123"},"title":{"type":"string","description":"The title of the commodity","example":"Commodity title"},"quantity":{"type":"number","description":"The quantity of the commodity","example":1},"hsCode":{"type":"string","description":"The HS code of the commodity","example":"123456789"},"weight":{"type":"number","description":"The weight of the commodity","example":1.5},"originCountry":{"type":"string","description":"The origin country of the commodity","example":"CZ"},"value":{"type":"number","description":"The value of the commodity","example":100},"currency":{"type":"string","description":"The currency of the commodity","example":"CZK"}}}}}},"seller":{"type":"string","example":"store.com"},"carrierOptions":{"type":"object","description":"The carrier options"},"status":{"type":"string","description":"The status of the shipment","enum":["IMPORTED","SENT","ERROR","PROCESSING","FINISHED"],"example":"SENT"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the shipment"}}}}}}}}},"/v1/shipment/:reference":{"get":{"summary":"Get a shipment","description":"Get a shipment by its reference","tags":["Shipment"],"parameters":[{"name":"reference","in":"path","description":"The reference of the shipment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The shipment","content":{"application/json":{"schema":{"type":"object","properties":{"carrier":{"type":"string","description":"The carrier","example":"PACKETA"},"carrierService":{"type":"object","description":"The carrier service"},"reference":{"type":"string","description":"The reference of the shipment","example":"123456789"},"note":{"type":"string","description":"The note of the shipment","example":"This is a note"},"recipient":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the contact person","example":"John"},"lastName":{"type":"string","description":"The last name of the contact person","example":"Doe"},"companyName":{"type":"string","description":"The company name","example":"ParcelSync"},"email":{"type":"string","description":"The email address","example":"j.doe@parcelsync.io"},"phone":{"type":"string","description":"The phone number","example":"+420 123 456 789"},"street":{"type":"string","description":"The street name","example":"Main Street"},"houseNumber":{"type":"string","description":"The house number","example":"123"},"city":{"type":"string","description":"The city","example":"Prague"},"country":{"type":"string","description":"The country","example":"CZ"},"postalCode":{"type":"string","description":"The postal code","example":"12345"},"pickupPoint":{"type":"string","description":"The pickup point","example":"ParcelShop"}}},"parcels":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"number","description":"The weight of the parcel in kilograms","example":1.5},"width":{"type":"number","description":"The width of the parcel in centimeters","example":10},"height":{"type":"number","description":"The height of the parcel in centimeters","example":10},"length":{"type":"number","description":"The length of the parcel in centimeters","example":10},"referenceNumber":{"type":"string","description":"The reference number of the parcel","example":"123456789"},"trackingNumber":{"type":"string","description":"The tracking number of the parcel","example":"123456789"}}}},"payment":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the payment","example":100},"currency":{"type":"string","description":"The currency of the payment","example":"CZK"},"type":{"type":"string","description":"The type of the payment","enum":["prepaid","cashondelivery"],"example":"prepaid"},"paymentReference":{"type":"string","description":"The payment reference","example":"123456789"}}},"insurance":{"type":"object","properties":{"value":{"type":"number","description":"The value of the insured parcel","example":100},"currency":{"type":"string","description":"The currency of the insured parcel","example":"CZK"}}},"customs":{"type":"object","properties":{"description":{"type":"string","description":"The description of the customs","example":"Customs description"},"totalValue":{"type":"number","description":"The total value of the customs","example":100},"currency":{"type":"string","description":"The currency of the customs","example":"CZK"},"commodities":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the commodity","example":"SKU123"},"title":{"type":"string","description":"The title of the commodity","example":"Commodity title"},"quantity":{"type":"number","description":"The quantity of the commodity","example":1},"hsCode":{"type":"string","description":"The HS code of the commodity","example":"123456789"},"weight":{"type":"number","description":"The weight of the commodity","example":1.5},"originCountry":{"type":"string","description":"The origin country of the commodity","example":"CZ"},"value":{"type":"number","description":"The value of the commodity","example":100},"currency":{"type":"string","description":"The currency of the commodity","example":"CZK"}}}}}},"seller":{"type":"string","example":"store.com"},"carrierOptions":{"type":"object","description":"The carrier options"},"status":{"type":"string","description":"The status of the shipment","enum":["IMPORTED","SENT","ERROR","PROCESSING","FINISHED"],"example":"SENT"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the shipment"}}}}}}}},"delete":{"summary":"Delete a shipment","description":"Delete a shipment","tags":["Shipment"],"parameters":[{"name":"reference","in":"path","description":"The shipment reference","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The shipment","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"put":{"summary":"Update a shipment","description":"Update a shipment","tags":["Shipment"],"parameters":[{"name":"reference","in":"path","description":"The shipment reference","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"carrier":{"type":"string"},"carrierService":{"type":"string","nullable":true},"reference":{"type":"string"},"note":{"type":"string","nullable":true},"seller":{"type":"string","nullable":true},"shipper":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"companyName":{"type":"string"},"email":{"type":"string","format":"email","nullable":true},"phone":{"type":"string"},"street":{"type":"string"},"houseNumber":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"postalCode":{"type":"string"}},"required":["phone"],"additionalProperties":false},"recipient":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"companyName":{"type":"string","nullable":true},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"street":{"type":"string","nullable":true},"houseNumber":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"pickupPoint":{"type":"string","nullable":true}},"additionalProperties":false},"parcels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"weight":{"type":"number","format":"float"},"width":{"type":"number","format":"float"},"height":{"type":"number","format":"float"},"length":{"type":"number","format":"float"},"referenceNumber":{"type":"string"}},"additionalProperties":false}},"payment":{"type":"object","properties":{"amount":{"type":"number","format":"float"},"currency":{"type":"string"},"type":{"type":"string","enum":["prepaid","cashondelivery"]},"paymentReference":{"type":"string"}},"additionalProperties":false},"insurance":{"type":"object","properties":{"value":{"type":"number","format":"float"},"currency":{"type":"string"}},"additionalProperties":false},"customs":{"type":"object","properties":{"description":{"type":"string"},"totalValue":{"type":"number","format":"float"},"currency":{"type":"string"},"commodities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":"string"},"title":{"type":"string"},"quantity":{"type":"number","format":"float"},"hsCode":{"type":"string"},"weight":{"type":"number","format":"float"},"originCountry":{"type":"string"},"value":{"type":"number","format":"float"},"currency":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false,"nullable":true},"carrierOptions":{"type":"object","properties":{},"additionalProperties":false,"nullable":true}},"additionalProperties":false}}}},"responses":{"200":{"description":"The shipment","content":{"application/json":{"schema":{"type":"object","properties":{"carrier":{"type":"string","description":"The carrier","example":"PACKETA"},"carrierService":{"type":"object","description":"The carrier service"},"reference":{"type":"string","description":"The reference of the shipment","example":"123456789"},"note":{"type":"string","description":"The note of the shipment","example":"This is a note"},"recipient":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the contact person","example":"John"},"lastName":{"type":"string","description":"The last name of the contact person","example":"Doe"},"companyName":{"type":"string","description":"The company name","example":"ParcelSync"},"email":{"type":"string","description":"The email address","example":"j.doe@parcelsync.io"},"phone":{"type":"string","description":"The phone number","example":"+420 123 456 789"},"street":{"type":"string","description":"The street name","example":"Main Street"},"houseNumber":{"type":"string","description":"The house number","example":"123"},"city":{"type":"string","description":"The city","example":"Prague"},"country":{"type":"string","description":"The country","example":"CZ"},"postalCode":{"type":"string","description":"The postal code","example":"12345"},"pickupPoint":{"type":"string","description":"The pickup point","example":"ParcelShop"}}},"parcels":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"number","description":"The weight of the parcel in kilograms","example":1.5},"width":{"type":"number","description":"The width of the parcel in centimeters","example":10},"height":{"type":"number","description":"The height of the parcel in centimeters","example":10},"length":{"type":"number","description":"The length of the parcel in centimeters","example":10},"referenceNumber":{"type":"string","description":"The reference number of the parcel","example":"123456789"},"trackingNumber":{"type":"string","description":"The tracking number of the parcel","example":"123456789"}}}},"payment":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the payment","example":100},"currency":{"type":"string","description":"The currency of the payment","example":"CZK"},"type":{"type":"string","description":"The type of the payment","enum":["prepaid","cashondelivery"],"example":"prepaid"},"paymentReference":{"type":"string","description":"The payment reference","example":"123456789"}}},"insurance":{"type":"object","properties":{"value":{"type":"number","description":"The value of the insured parcel","example":100},"currency":{"type":"string","description":"The currency of the insured parcel","example":"CZK"}}},"customs":{"type":"object","properties":{"description":{"type":"string","description":"The description of the customs","example":"Customs description"},"totalValue":{"type":"number","description":"The total value of the customs","example":100},"currency":{"type":"string","description":"The currency of the customs","example":"CZK"},"commodities":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the commodity","example":"SKU123"},"title":{"type":"string","description":"The title of the commodity","example":"Commodity title"},"quantity":{"type":"number","description":"The quantity of the commodity","example":1},"hsCode":{"type":"string","description":"The HS code of the commodity","example":"123456789"},"weight":{"type":"number","description":"The weight of the commodity","example":1.5},"originCountry":{"type":"string","description":"The origin country of the commodity","example":"CZ"},"value":{"type":"number","description":"The value of the commodity","example":100},"currency":{"type":"string","description":"The currency of the commodity","example":"CZK"}}}}}},"seller":{"type":"string","example":"store.com"},"carrierOptions":{"type":"object","description":"The carrier options"},"status":{"type":"string","description":"The status of the shipment","enum":["IMPORTED","SENT","ERROR","PROCESSING","FINISHED"],"example":"SENT"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the shipment"}}}}}}}}},"/v1/shipments/":{"post":{"summary":"Create a shipments in batch","description":"Create a shipments in batch","tags":["Shipment"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"carrier":{"type":"string"},"carrierService":{"type":"string","nullable":true},"reference":{"type":"string"},"note":{"type":"string","nullable":true},"seller":{"type":"string","nullable":true},"recipient":{"type":"object","properties":{"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"phone":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"houseNumber":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"pickupPoint":{"type":"string","nullable":true}},"additionalProperties":false},"parcels":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"number","format":"float"},"width":{"type":"number","format":"float"},"height":{"type":"number","format":"float"},"length":{"type":"number","format":"float"},"referenceNumber":{"type":"string"}},"required":["weight","width","height","length","referenceNumber"],"additionalProperties":false}},"payment":{"type":"object","properties":{"amount":{"type":"number","format":"float"},"currency":{"type":"string"},"type":{"type":"string","enum":["prepaid","cashondelivery"]},"paymentReference":{"type":"string"}},"required":["amount","currency","type"],"additionalProperties":false},"insurance":{"type":"object","properties":{"value":{"type":"number","format":"float"},"currency":{"type":"string"}},"required":["value","currency"],"additionalProperties":false},"customs":{"type":"object","properties":{"description":{"type":"string"},"totalValue":{"type":"number","format":"float"},"currency":{"type":"string"},"commodities":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"},"title":{"type":"string"},"quantity":{"type":"number","format":"float"},"hsCode":{"type":"string"},"weight":{"type":"number","format":"float"},"originCountry":{"type":"string"},"value":{"type":"number","format":"float"},"currency":{"type":"string"}},"required":["sku","title","quantity","hsCode","weight","originCountry","value","currency"],"additionalProperties":false}}},"required":["description","totalValue","currency"],"additionalProperties":false,"nullable":true},"carrierOptions":{"type":"object","properties":{},"additionalProperties":false,"nullable":true}},"required":["carrier","reference","recipient","parcels","payment"],"additionalProperties":false}}}}},"responses":{"200":{"description":"Shipments","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"carrier":{"type":"string","description":"The carrier","example":"PACKETA"},"carrierService":{"type":"object","description":"The carrier service"},"reference":{"type":"string","description":"The reference of the shipment","example":"123456789"},"note":{"type":"string","description":"The note of the shipment","example":"This is a note"},"recipient":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the contact person","example":"John"},"lastName":{"type":"string","description":"The last name of the contact person","example":"Doe"},"companyName":{"type":"string","description":"The company name","example":"ParcelSync"},"email":{"type":"string","description":"The email address","example":"j.doe@parcelsync.io"},"phone":{"type":"string","description":"The phone number","example":"+420 123 456 789"},"street":{"type":"string","description":"The street name","example":"Main Street"},"houseNumber":{"type":"string","description":"The house number","example":"123"},"city":{"type":"string","description":"The city","example":"Prague"},"country":{"type":"string","description":"The country","example":"CZ"},"postalCode":{"type":"string","description":"The postal code","example":"12345"},"pickupPoint":{"type":"string","description":"The pickup point","example":"ParcelShop"}}},"parcels":{"type":"array","items":{"type":"object","properties":{"weight":{"type":"number","description":"The weight of the parcel in kilograms","example":1.5},"width":{"type":"number","description":"The width of the parcel in centimeters","example":10},"height":{"type":"number","description":"The height of the parcel in centimeters","example":10},"length":{"type":"number","description":"The length of the parcel in centimeters","example":10},"referenceNumber":{"type":"string","description":"The reference number of the parcel","example":"123456789"},"trackingNumber":{"type":"string","description":"The tracking number of the parcel","example":"123456789"}}}},"payment":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the payment","example":100},"currency":{"type":"string","description":"The currency of the payment","example":"CZK"},"type":{"type":"string","description":"The type of the payment","enum":["prepaid","cashondelivery"],"example":"prepaid"},"paymentReference":{"type":"string","description":"The payment reference","example":"123456789"}}},"insurance":{"type":"object","properties":{"value":{"type":"number","description":"The value of the insured parcel","example":100},"currency":{"type":"string","description":"The currency of the insured parcel","example":"CZK"}}},"customs":{"type":"object","properties":{"description":{"type":"string","description":"The description of the customs","example":"Customs description"},"totalValue":{"type":"number","description":"The total value of the customs","example":100},"currency":{"type":"string","description":"The currency of the customs","example":"CZK"},"commodities":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the commodity","example":"SKU123"},"title":{"type":"string","description":"The title of the commodity","example":"Commodity title"},"quantity":{"type":"number","description":"The quantity of the commodity","example":1},"hsCode":{"type":"string","description":"The HS code of the commodity","example":"123456789"},"weight":{"type":"number","description":"The weight of the commodity","example":1.5},"originCountry":{"type":"string","description":"The origin country of the commodity","example":"CZ"},"value":{"type":"number","description":"The value of the commodity","example":100},"currency":{"type":"string","description":"The currency of the commodity","example":"CZK"}}}}}},"seller":{"type":"string","example":"store.com"},"carrierOptions":{"type":"object","description":"The carrier options"},"status":{"type":"string","description":"The status of the shipment","enum":["IMPORTED","SENT","ERROR","PROCESSING","FINISHED"],"example":"SENT"},"createdAt":{"type":"string","format":"date-time","description":"The creation date of the shipment"}}}}}}}}}},"/v1/shipments/carrier/ship":{"post":{"summary":"Ship shipments data to carriers","description":"Ship shipments data to carriers. Response is divided by carriers.","tags":["Shipments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipments":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"}},"required":["reference"],"additionalProperties":false}}},"required":["shipments"],"additionalProperties":false}}}},"responses":{"200":{"description":"Responses from carriers","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"}}}}}}}}}}},"/v1/shipments/carrier/label":{"post":{"summary":"Obtain labels for shipments","description":"Obtain labels for shipments","tags":["Shipments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipments":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"}},"required":["reference"],"additionalProperties":false}}},"required":["shipments"],"additionalProperties":false}}}},"responses":{"200":{"description":"Labels in base64 PDF per carrier of specified shipments","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string","format":"base64"}}}}}}}},"/v1/shipments/carrier/waybill":{"post":{"summary":"Obtain waybills for shipments","description":"Obtain waybills for shipments","tags":["Shipments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipments":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"}},"required":["reference"],"additionalProperties":false}}},"required":["shipments"],"additionalProperties":false}}}},"responses":{"200":{"description":"Waybills in A4 base64 PDF per carrier of specified shipments","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string","format":"base64"}}}}}}}},"/v1/shipments/carrier/status":{"post":{"summary":"Obtain statuses of shipments","description":"Obtain statuses of shipments. Either shipments or trackingIds must be provided. If both are provided, shipments will be used. additionalProp${INT} is the carrier name","tags":["Shipments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipments":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"}},"required":["reference"],"additionalProperties":false}},"trackingIds":{"type":"object","properties":{},"additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":false}}}},"responses":{"200":{"description":"Statuses per carrier of specified shipments","content":{"application/json":{"schema":{"type":"object","properties":{"responsesByCarrier":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string","enum":["EXCEPTION","DATA_SENT","ACCEPTED_BY_CARRIER","HANDED_OVER","IN_TRANSIT","OUT_FOR_DELIVERY","STORED_FOR_PICKUP","PICKED_UP","DELIVERED","DELIVERY_FAILED","RETURNED","CANCELED","SKIP_STATUS"]},"status":{"type":"string","enum":["success","error"]},"metadata":{"type":"object","describe":"Carrier specific metadata, e.g. TOLL, FUEL, etc."}}}}}}}}}}}}}}}