how can i install this api on my prestashop website

[ru5hm3]

hello, i have an aplication that integrate all the couriers, how can i install it in my website. the following come must be adapted for prestashop.

{ "openapi": "3.0.1", "info": { "title": "Innoship API", "description": "Api service implementation (version:3.1.4.296)", "termsOfService": "https://example.com/terms", "contact": { "name": "Andrei Paul", "email": "[email protected]" }, "license": { "name": "Use under LICX", "url": "https://example.com/license" }, "version": "v1" }, "paths": { "/api/Courier/RequestPickup": { "post": { "tags": [ "Courier" ], "summary": "Request pickup to courier", "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PickupRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PickupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PickupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PickupRequest" } } } }, "responses": { "200": { "description": "Pickup requested to courier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckCredentialsResponse" } } } }, "400": { "description": "Unable to request pickup due to errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unable to authorize request" } } } }, "/api/Courier/All": { "get": { "tags": [ "Courier" ], "summary": "Get all couriers", "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "responses": { "200": { "description": "List of couriers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllCouriersResponse" } } } } }, "401": { "description": "Unable to authorize request" } } } }, "/api/Feedback/{from}/{to}": { "get": { "tags": [ "Feedback" ], "parameters": [ { "name": "from", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Label/by-courier/{courierId}/awb/{awb}": { "get": { "tags": [ "Label" ], "summary": "Gets the label for the specified courier awb number", "parameters": [ { "name": "courierId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "", "format": "int32" } }, { "name": "awb", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "type", "in": "query", "description": "", "schema": { "type": "string", "description": "", "default": "PDF", "nullable": true } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "description": "", "default": "A6", "nullable": true } }, { "name": "useFile", "in": "query", "description": "", "schema": { "type": "boolean", "description": "", "default": true } }, { "name": "skipCache", "in": "query", "description": "", "schema": { "type": "boolean", "description": "", "default": false } }, { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "responses": { "200": { "description": "Returns the label", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/LabelResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LabelResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LabelResponse" } } } }, "400": { "description": "Unable to get the label due to validation errors", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unable to authorize request" } } } }, "/api/Label/by-courier/{courierId}/parcel/{barcodes}": { "get": { "tags": [ "Label" ], "summary": "Gets the label for the specified courier awb number", "parameters": [ { "name": "courierId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "", "format": "int32" } }, { "name": "barcodes", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "type", "in": "query", "description": "", "schema": { "type": "string", "description": "", "default": "PDF", "nullable": true } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "description": "", "default": "A6", "nullable": true } }, { "name": "useFile", "in": "query", "description": "", "schema": { "type": "boolean", "description": "", "default": true } }, { "name": "skipCache", "in": "query", "description": "", "schema": { "type": "boolean", "description": "", "default": false } }, { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "responses": { "200": { "description": "Returns the label", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/LabelResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LabelResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LabelResponse" } } } }, "400": { "description": "Unable to get the label due to validation errors", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unable to authorize request" } } } }, "/api/Location/ClientLocations": { "get": { "tags": [ "Location" ], "responses": { "200": { "description": "Success" } } } }, "/api/Location/FixedLocations": { "get": { "tags": [ "Location" ], "parameters": [ { "name": "Courier", "in": "query", "schema": { "$ref": "#/components/schemas/Courier" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "CountyName", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "LocalityName", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "FixedLocationType", "in": "query", "schema": { "$ref": "#/components/schemas/FixedLocationType" } }, { "name": "ShowInactive", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "RestrictionParcelsCount", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "RestrictionSizeHeight", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "RestrictionSizeWidth", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "RestrictionSizeLength", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "ExternalLocationId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Location/Countries": { "get": { "tags": [ "Location" ], "responses": { "200": { "description": "Success" } } } }, "/api/Location/Counties/{CountryCode}": { "get": { "tags": [ "Location" ], "parameters": [ { "name": "CountryCode", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Location/Localities/{CountyId}": { "get": { "tags": [ "Location" ], "parameters": [ { "name": "CountyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } } } }, "/api/Location/Postalcodes/{CountryCode}/{PostalCode}": { "get": { "tags": [ "Location" ], "parameters": [ { "name": "CountryCode", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "PostalCode", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PostalCodeModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostalCodeModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostalCodeModel" } } } } } } }, "/api/Location/Postalcodes/{LocalityId}": { "get": { "tags": [ "Location" ], "parameters": [ { "name": "LocalityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalityPostalCodeModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalityPostalCodeModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocalityPostalCodeModel" } } } } } } } }, "/api/Manifest": { "post": { "tags": [ "Manifest" ], "summary": "Requests pickup and get manifest id", "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ManifestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ManifestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManifestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ManifestRequest" } } } }, "responses": { "400": { "description": "Unable to process due to validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "Returns ManifestId" }, "401": { "description": "Unable to authorize request" } } }, "get": { "tags": [ "Manifest" ], "summary": "Requests manifest report by id", "parameters": [ { "name": "manifestId", "in": "query", "description": "", "schema": { "type": "integer", "description": "", "format": "int64" } }, { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "responses": { "400": { "description": "Unable to process due to validation errors", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "Returns PDF" }, "401": { "description": "Unable to authorize request" } } } }, "/api/Order": { "post": { "tags": [ "Order" ], "summary": "Creates a new order", "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.9040398+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.9040398+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.9040398+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.9040398+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} } } }, "responses": { "201": { "description": "Creates an new order in the system", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" }, "example": {"clientOrderId":662,"courierShipmentId":"877551879","courier":1,"courierParcelsBarcodes":null,"price":{"amount":13.36,"vat":2.54,"totalAmount":15.90,"currency":"RON","priceComponents":null},"calculatedDeliveryDate":"2019-10-03T00:00:00+00:00","trackPageUrl":null,"courierResponse":null,"extra":null} } } }, "400": { "description": "Unable to create the order due to validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unable to authorize request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/Order/validate": { "post": { "tags": [ "Order" ], "summary": "Validates a new order request", "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.905711+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.905711+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.905711+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.905711+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" }, "example": {"clientOrderId":662,"courierShipmentId":"877551879","courier":1,"courierParcelsBarcodes":null,"price":{"amount":13.36,"vat":2.54,"totalAmount":15.90,"currency":"RON","priceComponents":null},"calculatedDeliveryDate":"2019-10-03T00:00:00+00:00","trackPageUrl":null,"courierResponse":null,"extra":null} } } }, "400": { "description": "Unable to create the order due to validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unable to authorize request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Creates an new order in the system" } } } }, "/api/Order/file": { "post": { "tags": [ "Order" ], "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OrderResponseResponseWithErrors" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/Order/{courierId}/awb/{awbNo}": { "delete": { "tags": [ "Order" ], "summary": "Deletes an existing order", "parameters": [ { "name": "courierId", "in": "path", "description": "Courier id", "required": true, "schema": { "type": "integer", "description": "Courier id", "format": "int32" } }, { "name": "awbNo", "in": "path", "description": "AWB number", "required": true, "schema": { "type": "string", "description": "AWB number", "nullable": true } }, { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "responses": { "201": { "description": "Deletes an existing order from the system", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" }, "example": {"clientOrderId":662,"courierShipmentId":"877551879","courier":1,"courierParcelsBarcodes":null,"price":{"amount":13.36,"vat":2.54,"totalAmount":15.90,"currency":"RON","priceComponents":null},"calculatedDeliveryDate":"2019-10-03T00:00:00+00:00","trackPageUrl":null,"courierResponse":null,"extra":null} } } }, "400": { "description": "Unable to delete the order due to validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unable to authorize request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/Order/UpdateStatus": { "post": { "tags": [ "Order" ], "summary": "Updates orders statuses", "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateStatusRequest" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateStatusRequest" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateStatusRequest" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateStatusRequest" }, "description": "", "nullable": true } } } }, "responses": { "400": { "description": "Unable to process due to validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unable to authorize request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "Request was processed successfully" } } } }, "/api/Order/UpdateParcels": { "post": { "tags": [ "Order" ], "summary": "Create a new order based on the existing one and cancel the original", "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateParcelsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParcelsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateParcelsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateParcelsRequest" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" }, "example": {"clientOrderId":662,"courierShipmentId":"877551879","courier":1,"courierParcelsBarcodes":null,"price":{"amount":13.36,"vat":2.54,"totalAmount":15.90,"currency":"RON","priceComponents":null},"calculatedDeliveryDate":"2019-10-03T00:00:00+00:00","trackPageUrl":null,"courierResponse":null,"extra":null} } } }, "400": { "description": "Unable to create the order due to validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unable to authorize request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "Creates an new order in the system" } } } }, "/api/Price": { "post": { "tags": [ "Price" ], "summary": "Gets the prices for the specified request", "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.9111161+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.9111161+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.9111161+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderRequest" }, "example": {"serviceId":1,"courierId":null,"shipmentDate":"2021-11-16T10:52:15.9111161+00:00","shipmentDateEnd":"0001-01-01T00:00:00+00:00","addressFrom":null,"addressTo":{"name":"Name of recipient","contactPerson":"Contact for recipient","country":"RO","countryName":null,"countyId":null,"localityId":null,"countryId":null,"countyName":"Bucuresti","localityName":"Bucuresti","addressText":"adress text 10","postalCode":"123456","phone":"+40734123456","email":"[email protected]","fixedLocationId":null,"courierFixedLocationId":null,"fixedLocationName":null},"payment":"Sender","content":{"envelopeCount":0,"parcelsCount":1,"palettesCount":0,"totalWeight":1.0,"contents":"t-shirt","package":"box","oversizedPackage":false,"parcels":[{"sequenceNo":1,"size":{"width":20.0,"height":50.0,"length":20.0},"weight":1.0,"type":"Parcel","reference1":"invoice for order 222","reference2":null,"customerBarcode":null}]},"extra":{"bankRepaymentAmount":32.12,"bankRepaymentCurrency":null,"cashOnDeliveryAmount":null,"cashOnDeliveryAmountCurrency":null,"declaredValueAmount":null,"declaredValueAmountCurrency":null,"openPackage":true,"saturdayDelivery":null,"insuranceAmount":null,"insuranceAmountCurrency":null,"reference1":null,"reference2":null,"reference3":null,"reference4":null,"returnOfDocuments":null,"returnOfDocumentsComment":null,"returnPackage":null,"bank":null,"bankIBAN":null},"parameters":{"async":true,"getParcelsBarcodes":false,"includeCourierResponse":false,"includePriceBreakdown":false},"externalClientLocation":"RO","externalOrderId":null,"metadata":"extra data information","sourceChannel":"ONLINE","observation":"Call one hour before","customAttributes":null,"clientSettings":null} } } }, "responses": { "201": { "description": "List of prices for eligible couriers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceResponse" } } } }, "400": { "description": "Unable to get prices due to validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unable to authorize request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/Track/by-awb/with-return": { "post": { "tags": [ "Track" ], "summary": "Track by Order Courier AWB with return info", "parameters": [ { "name": "api-version", "in": "query", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } }, { "name": "api-version", "in": "header", "description": "The requested API version", "schema": { "type": "string", "default": "1.0" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TrackRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResponseWithReturnInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResponseWithReturnInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResponseWithReturnInfo" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "components": { "schemas": { "PickupRequest": { "type": "object", "properties": { "courierId": { "type": "integer", "format": "int32" }, "locationId": { "type": "integer", "format": "int32" }, "lastPickupHour": { "type": "integer", "format": "int32" }, "lastPickMinute": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CheckCredentialsResponse": { "type": "object", "properties": { "credentialsOk": { "type": "boolean" } }, "additionalProperties": false }, "ErrorResponseItem": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponseItem" }, "nullable": true }, "correlationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AllCouriersResponse": { "type": "object", "properties": { "courierId": { "type": "integer", "format": "int32" }, "courier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LabelResponse": { "type": "object", "properties": { "courier": { "type": "integer", "format": "int32" }, "contents": { "type": "string", "nullable": true }, "labels": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Courier": { "enum": [ "InnoshipMocked", "Cargus", "DPD", "FanCourier", "GLS", "Nemo", "Sameday", "ExpressOne", "ECont", "TeamCourier", "DHL", "PostaRomana", "PostaPanduri", "GLS_HU", "DragonStar", "Coletaria", "Bookurier", "Asendia", "TNT", "DPD_BG", "GLS_HR", "GLS_CZ", "GLS_SI", "GLS_SK", "InOut", "StackCurier", "GebruderWeiss", "Pallex", "GT", "CourierManager", "GLS_IT", "ECourier", "Unimasters", "TCE", "TransilvaniaPost", "BGPost", "Evropat", "SMPCourier", "DHL_DE", "Raben", "Memex", "PTTExpress", "XDCourier", "IL", "NovaPosta", "PinkPost", "Strongo", "DHL_Paket", "DHL_Parcel", "BeeFast", "InPost", "KLG", "Schenker", "Packageez" ], "type": "string" }, "FixedLocationType": { "enum": [ "Locker", "PickupPoint" ], "type": "string" }, "PostalCodeStreet": { "type": "object", "properties": { "localityId": { "type": "integer", "format": "int32" }, "localityName": { "type": "string", "nullable": true }, "countyId": { "type": "integer", "format": "int32" }, "countyName": { "type": "string", "nullable": true }, "countryId": { "type": "integer", "format": "int32" }, "countryName": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "group": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PostalCodeModel": { "type": "object", "properties": { "countryCode": { "type": "string", "nullable": true }, "countryName": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "streets": { "type": "array", "items": { "$ref": "#/components/schemas/PostalCodeStreet" }, "nullable": true } }, "additionalProperties": false }, "LocalityPostalCodeModel": { "type": "object", "properties": { "localityId": { "type": "integer", "format": "int32" }, "postalCode": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ManifestRequest": { "type": "object", "properties": { "courierId": { "$ref": "#/components/schemas/Courier" }, "externalLocationId": { "type": "string", "nullable": true }, "lastPickHour": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "OrderRequestAddress": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "contactPerson": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "countryName": { "type": "string", "nullable": true }, "countyId": { "type": "integer", "format": "int32", "nullable": true }, "localityId": { "type": "integer", "format": "int32", "nullable": true }, "countryId": { "type": "integer", "format": "int32", "nullable": true }, "countyName": { "type": "string", "nullable": true }, "localityName": { "type": "string", "nullable": true }, "addressText": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "fixedLocationId": { "type": "string", "nullable": true }, "courierFixedLocationId": { "type": "string", "nullable": true }, "fixedLocationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentType": { "enum": [ "Sender", "Recipient" ], "type": "string" }, "OrderRequestContentParcelSize": { "type": "object", "properties": { "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ParcelType": { "enum": [ "Envelope", "Parcel", "Pallet" ], "type": "string" }, "OrderRequestContentParcel": { "type": "object", "properties": { "sequenceNo": { "type": "integer", "format": "int32" }, "size": { "$ref": "#/components/schemas/OrderRequestContentParcelSize" }, "weight": { "type": "number", "format": "double" }, "type": { "$ref": "#/components/schemas/ParcelType" }, "reference1": { "type": "string", "nullable": true }, "reference2": { "type": "string", "nullable": true }, "customerBarcode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderRequestContent": { "type": "object", "properties": { "envelopeCount": { "type": "integer", "format": "int32" }, "parcelsCount": { "type": "integer", "format": "int32" }, "palettesCount": { "type": "integer", "format": "int32" }, "totalWeight": { "type": "number", "format": "double" }, "contents": { "type": "string", "nullable": true }, "package": { "type": "string", "nullable": true }, "oversizedPackage": { "type": "boolean" }, "parcels": { "type": "array", "items": { "$ref": "#/components/schemas/OrderRequestContentParcel" }, "nullable": true } }, "additionalProperties": false }, "OrderRequestExtra": { "type": "object", "properties": { "bankRepaymentAmount": { "type": "number", "format": "double", "nullable": true }, "bankRepaymentCurrency": { "type": "string", "nullable": true }, "cashOnDeliveryAmount": { "type": "number", "format": "double", "nullable": true }, "cashOnDeliveryAmountCurrency": { "type": "string", "nullable": true }, "declaredValueAmount": { "type": "number", "format": "double", "nullable": true }, "declaredValueAmountCurrency": { "type": "string", "nullable": true }, "openPackage": { "type": "boolean", "nullable": true }, "saturdayDelivery": { "type": "boolean", "nullable": true }, "insuranceAmount": { "type": "number", "format": "double", "nullable": true }, "insuranceAmountCurrency": { "type": "string", "nullable": true }, "reference1": { "type": "string", "nullable": true }, "reference2": { "type": "string", "nullable": true }, "reference3": { "type": "string", "nullable": true }, "reference4": { "type": "string", "nullable": true }, "returnOfDocuments": { "type": "boolean", "nullable": true }, "returnOfDocumentsComment": { "type": "string", "nullable": true }, "returnPackage": { "type": "boolean", "nullable": true }, "bank": { "type": "string", "nullable": true }, "bankIBAN": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderRequestParameters": { "type": "object", "properties": { "async": { "type": "boolean" }, "getParcelsBarcodes": { "type": "boolean" }, "includeCourierResponse": { "type": "boolean" }, "includePriceBreakdown": { "type": "boolean" } }, "additionalProperties": false }, "LabelFormat": { "enum": [ "A4", "A6", "T_85x85" ], "type": "string" }, "ClientPreferences": { "type": "object", "properties": { "preferredLabel": { "$ref": "#/components/schemas/LabelFormat" }, "preferredLocationId": { "type": "integer", "format": "int32", "nullable": true }, "orderColumns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pickupColumns": { "type": "array", "items": { "type": "string" }, "nullable": true }, "returnColumns": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OrderRequestClientSettings": { "type": "object", "properties": { "trackPageDomainName": { "type": "string", "nullable": true }, "priceWeight": { "type": "number", "format": "double", "nullable": true }, "performanceWeight": { "type": "number", "format": "double", "nullable": true }, "performanceMaximumPriceDeviation": { "type": "number", "format": "double", "nullable": true }, "clientPreferences": { "$ref": "#/components/schemas/ClientPreferences" }, "senderLocationTimeZoneId": { "type": "string", "nullable": true }, "doNoSaveGDPRData": { "type": "boolean", "nullable": true }, "openPackageIsOptional": { "type": "boolean", "nullable": true }, "saturdayDeliveryIsOptional": { "type": "boolean", "nullable": true }, "uniqueOrderReferenceId": { "type": "integer", "format": "int32", "nullable": true }, "performanceClientRates": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "nullable": true } }, "additionalProperties": false }, "OrderRequest": { "type": "object", "properties": { "serviceId": { "type": "integer", "format": "int32" }, "courierId": { "$ref": "#/components/schemas/Courier" }, "shipmentDate": { "type": "string", "format": "date-time" }, "shipmentDateEnd": { "type": "string", "format": "date-time" }, "addressFrom": { "$ref": "#/components/schemas/OrderRequestAddress" }, "addressTo": { "$ref": "#/components/schemas/OrderRequestAddress" }, "payment": { "$ref": "#/components/schemas/PaymentType" }, "content": { "$ref": "#/components/schemas/OrderRequestContent" }, "extra": { "$ref": "#/components/schemas/OrderRequestExtra" }, "parameters": { "$ref": "#/components/schemas/OrderRequestParameters" }, "externalClientLocation": { "type": "string", "nullable": true }, "externalOrderId": { "type": "string", "nullable": true }, "metadata": { "type": "string", "nullable": true }, "sourceChannel": { "type": "string", "nullable": true }, "observation": { "type": "string", "nullable": true }, "customAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "clientSettings": { "$ref": "#/components/schemas/OrderRequestClientSettings" } }, "additionalProperties": false }, "OrderBarcodes": { "type": "object", "properties": { "sequenceNo": { "type": "integer", "format": "int32" }, "barcode": { "type": "string", "nullable": true }, "customerBarcode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderResponsePrice": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "vat": { "type": "number", "format": "double" }, "totalAmount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "priceComponents": { "type": "object", "properties": { "Km": { "type": "number", "format": "double" }, "KmFixed": { "type": "number", "format": "double" }, "Envelopes": { "type": "number", "format": "double" }, "ContentWeight": { "type": "number", "format": "double" }, "Insurance": { "type": "number", "format": "double" }, "CashOnDelivery": { "type": "number", "format": "double" }, "BankRepayment": { "type": "number", "format": "double" }, "FixedExtras": { "type": "number", "format": "double" }, "Returns": { "type": "number", "format": "double" }, "FuelSurcharge": { "type": "number", "format": "double" }, "CourierPrice": { "type": "number", "format": "double" }, "OpenPackage": { "type": "number", "format": "double" }, "SaturdayDelivery": { "type": "number", "format": "double" }, "PriceForExtraParcel": { "type": "number", "format": "double" }, "ContentWeightZones": { "type": "number", "format": "double" }, "ContentWeightPiecesZones": { "type": "number", "format": "double" }, "PickupThirdParty": { "type": "number", "format": "double" } }, "nullable": true } }, "additionalProperties": false }, "OrderResponse": { "type": "object", "properties": { "clientOrderId": { "type": "integer", "format": "int32", "nullable": true }, "courierShipmentId": { "type": "string", "nullable": true }, "courier": { "type": "integer", "format": "int32" }, "courierParcelsBarcodes": { "type": "array", "items": { "$ref": "#/components/schemas/OrderBarcodes" }, "nullable": true }, "price": { "$ref": "#/components/schemas/OrderResponsePrice" }, "calculatedDeliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "trackPageUrl": { "type": "string", "nullable": true }, "courierResponse": { "type": "object", "additionalProperties": { }, "nullable": true }, "extra": { "$ref": "#/components/schemas/OrderRequestExtra" } }, "additionalProperties": false }, "Error": { "type": "object", "properties": { "context": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true } }, "additionalProperties": false }, "OrderResponseResponseWithErrors": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/OrderResponse" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "correlationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateStatusRequest": { "type": "object", "properties": { "courierId": { "$ref": "#/components/schemas/Courier" }, "courierShipmentId": { "type": "string", "nullable": true }, "statusId": { "type": "integer", "format": "int32" }, "actionDateTime": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UpdateParcelsRequest": { "type": "object", "properties": { "courierId": { "$ref": "#/components/schemas/Courier" }, "courierShipmentId": { "type": "string", "nullable": true }, "envelopeCount": { "type": "integer", "format": "int32" }, "parcelsCount": { "type": "integer", "format": "int32" }, "palettesCount": { "type": "integer", "format": "int32" }, "oversizedPackage": { "type": "boolean" }, "totalWeight": { "type": "number", "format": "double" }, "parcels": { "type": "array", "items": { "$ref": "#/components/schemas/OrderRequestContentParcel" }, "nullable": true } }, "additionalProperties": false }, "PriceRate": { "type": "object", "properties": { "carrierId": { "type": "integer", "format": "int32" }, "carrier": { "type": "string", "nullable": true }, "rateAmount": { "type": "number", "format": "double" }, "rateVatAmount": { "type": "number", "format": "double" }, "rateCurrency": { "type": "string", "nullable": true }, "score": { "type": "number", "format": "double" }, "performance": { "type": "number", "format": "double" }, "deliveryDays": { "type": "integer", "format": "int32" }, "serviceId": { "type": "integer", "format": "int32" }, "service": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PriceResponse": { "type": "object", "properties": { "rates": { "type": "array", "items": { "$ref": "#/components/schemas/PriceRate" }, "nullable": true } }, "additionalProperties": false }, "TrackRequest": { "type": "object", "properties": { "courier": { "$ref": "#/components/schemas/Courier" }, "awbList": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TrackResponseHistory": { "type": "object", "properties": { "clientStatusId": { "type": "integer", "format": "int32" }, "clientStatusDescription": { "type": "string", "nullable": true }, "eventDate": { "type": "string", "format": "date-time" }, "isFinalStatus": { "type": "boolean" } }, "additionalProperties": false }, "TrackResponseWithReturnInfo": { "type": "object", "properties": { "returnAwb": { "type": "string", "nullable": true }, "returnAwbHistory": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResponseHistory" }, "nullable": true }, "orderId": { "type": "integer", "format": "int32" }, "courier": { "type": "integer", "format": "int32" }, "shipmentAwb": { "type": "string", "nullable": true }, "carrierMeasuredWeight": { "type": "number", "format": "double", "nullable": true }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResponseHistory" }, "nullable": true }, "cashOnDeliveryHistory": { "type": "array", "items": { "$ref": "#/components/schemas/TrackResponseHistory" }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "X-Api-Key", "in": "header" } } }, "security": [ { "ApiKeyAuth": [ "readAccess", "writeAccess" ] } ] }

[Nickz]

11 hours ago, ru5hm3 said:

Innoship API

You need someone who converts the magento extension int a PS Module.

Not cheap I reckon.