{ "openapi": "3.0.0", "info": { "title": "Carrier API documentation", "description": "\n API server URL: https://starlinksapi.app/api/v1\nAPI is a set of tools that allow users to work with parcels.\nThe most common use-case of the provided API is:\n1. Create a new parcel using /parcels endpoint\n2. Start tracking the created parcel using the /history or /date-range-history endpoints\n3. API also provides an ability to cancel the created parcel using the /cancel endpoint. In this case, the parcel\n will stop receiving tracking events and will not be sent\n ", "version": "1.0.0" }, "servers": [ { "url": "https://starlinksapi.app/api/v1", "description": "API Server" } ], "paths": { "/shipsy": { "post": { "tags": [ "Shipments" ], "description": "Store shipment using Shipsy payload", "operationId": "Store shipment using Shipsy payload", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreShipsyRequest" } } } }, "responses": { "200": { "description": "Shipment successfully created." }, "401": { "description": "Authentication Error: API Key not Provided", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "message": { "type": "string", "example": "API key should be present", "nullable": false }, "reason": { "type": "string", "example": "NO_API_KEY", "nullable": false }, "statusCode": { "type": "integer", "example": 401, "nullable": false } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "schema": { "properties": { "message": { "description": "Error message", "type": "string" }, "errors": { "description": "Error messages that describes the reason of failure.", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } }, "type": "object", "nullable": false } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/shipsy/track": { "post": { "tags": [ "Shipments" ], "description": "Track shipment using Shipsy payload", "operationId": "Track shipment using Shipsy payload", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackShipsyRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "format": "object", "items": { "properties": { "reference_number": { "description": "Track number of shipment", "type": "string", "example": "AE1234456" }, "success": { "description": "Success or failure response", "type": "boolean", "example": true }, "data": { "description": "Data", "properties": { "reference_number": { "description": "Track number of shipment", "type": "string", "example": "AE1234456" }, "customer_reference_number": { "description": "customer_reference_number", "type": "string", "example": "" }, "service_type_id": { "description": "service_type_id", "type": "integer", "example": 1 }, "attempt_count": { "description": "attempt_count", "type": "integer", "example": 0 }, "status": { "description": "status", "type": "string", "example": "unknown" }, "delivery_kyc_type": { "description": "delivery_kyc_type", "type": "string", "example": null }, "delivery_kyc_number": { "description": "delivery_kyc_number", "type": "string", "example": null }, "is_cod": { "description": "is_cod", "type": "boolean", "example": true }, "cod_amount": { "description": "cod_amount", "type": "number", "example": 123.45 }, "pop_image": { "description": "pop_image", "type": "string", "example": null }, "pop_signature_image": { "description": "pop_signature_image", "type": "string", "example": null }, "poc_image_list": { "description": "poc_image_list", "type": "string", "example": null }, "pop_image_list": { "description": "pop_image_list", "type": "string", "example": null }, "weight": { "description": "weight", "type": "number", "example": 5.5 }, "creation_date": { "description": "creation_date", "type": "string", "example": "2024-01-01 10:00:00" }, "receiver_name": { "description": "receiver_name", "type": "string", "example": "John" }, "receiver_relation": { "description": "receiver_relation", "type": "string", "example": null }, "hub_code": { "description": "hub_code", "type": "string", "example": "RUH" }, "events": { "description": "events", "type": "array", "items": { "properties": { "type": { "description": "type", "type": "string", "example": "created" }, "event_time": { "description": "event_time", "type": "string", "example": "2342534653456" }, "hub_name": { "description": "hub_name", "type": "string", "example": "RUH" }, "hub_code": { "description": "hub_code", "type": "string", "example": "RUH" }, "customer_update": { "description": "customer_update", "type": "string", "example": "" }, "notes": { "description": "notes", "type": "string", "example": "" }, "is_otp_verified": { "description": "is_otp_verified", "type": "string", "example": null }, "poc_image": { "description": "poc_image", "type": "string", "example": null }, "failure_reason": { "description": "failure_reason", "type": "string", "example": null }, "failure_reason_id": { "description": "failure_reason_id", "type": "string", "example": null }, "signature_image": { "description": "signature_image", "type": "string", "example": null }, "pop_image": { "description": "pop_image", "type": "string", "example": null }, "pop_signature_image": { "description": "pop_signature_image", "type": "string", "example": null } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Authentication Error: API Key not Provided", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "message": { "type": "string", "example": "API key should be present", "nullable": false }, "reason": { "type": "string", "example": "NO_API_KEY", "nullable": false }, "statusCode": { "type": "integer", "example": 401, "nullable": false } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object" }, "errors": { "description": "Error messages that describes the reason of failure.", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } }, "type": "object", "nullable": false } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/shipsy/shippinglabel/stream/{reference_number}": { "get": { "tags": [ "Shipments" ], "description": "Client Label Generation Upload", "operationId": "Client Label Generation Upload", "parameters": [ { "name": "reference_number", "in": "path", "description": "Reference number/AWB number of Consignment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error due to Invalid Reference Number", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "message": { "type": "string", "example": "Invalid Reference Number", "nullable": false }, "reason": { "type": "string", "example": "WRONG_INPUT", "nullable": false }, "code": { "type": "string", "example": "WRONG_INPUT", "nullable": false }, "statusCode": { "type": "integer", "example": 400, "nullable": false } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Authentication Error: API Key not Provided", "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "message": { "type": "string", "example": "API key should be present", "nullable": false }, "reason": { "type": "string", "example": "NO_API_KEY", "nullable": false }, "statusCode": { "type": "integer", "example": 401, "nullable": false } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/parcelgroups": { "post": { "tags": [ "ParcelGroups" ], "summary": "Store new parcel group", "description": "\n This endpoint can be used to register new parcel groups.\n A parcel group is a set of parcels enclosed withing a physical entity (bag, pallet, shipment).\n A parcel group has its own tracking number.\n The API request result is the tracking number and the shipping label of the created parcel group\n This endpoint is available for both Shipper and Warehouse operator roles\n ", "operationId": "storeParcelGroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreParcelGroup" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "tracking_number": { "description": "Group Tracking Number", "format": "string", "example": "000000000012637" }, "label": { "description": "Parcel Group Label", "format": "string", "example": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/KQovQ3JlYXRvciAo/v8AdwBrAGgAdABtAGwAdABvAHAAZABmACAAMAAuADEAMgAuADEALgA0KQovUHJvZHVjZXIgKP7/AFEAdAAgADQALgA4AC4ANikKL0NyZWF..." } }, "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/parcels": { "post": { "tags": [ "Parcels" ], "summary": "Store new parcel", "description": "This endpoint can be used to register new parcels.\n * The result is the generated carrier tracking number and a shipping label in the chosen format", "operationId": "storeParcel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParcelBaseRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "tracking_number": { "description": "Carrier Tracking Number", "format": "string", "example": "000000000012637", "deprecated": true }, "customs_broker_tracking_number": { "description": "Customs broker reference", "format": "string", "example": "ST17471", "deprecated": true }, "label": { "description": "Parcel Carrier Label", "format": "string", "example": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/KQovQ3JlYXRvciAo/v8AdwBrAGgAdABtAGwAdABvAHAAZABmACAAMAAuADEAMgAuADEALgA0KQovUHJvZHVjZXIgKP7/AFEAdAAgADQALgA4AC4ANikKL0NyZWF...", "deprecated": true } }, "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "deprecated": true } }, "/cancel": { "post": { "tags": [ "Parcels" ], "summary": "Cancel Parcel", "description": "This endpoint can be used to cancel the created parcels.\n * There is an important restriction on the parcel cancelation, the parcel cannot be canceled\n * in case it's already left the warehouse. In the technical terms, this means only the parcels\n * that have CREATED or ERROR status can be canceled", "operationId": "cancelParcel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelParcelRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "{tracking_number}": { "description": "Carrier Tracking Number", "format": "string", "example": "Canceled", "deprecated": true } }, "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "deprecated": true } }, "/history": { "post": { "tags": [ "Parcels" ], "summary": "Get parcels tracking", "description": "\n This endpoint can be used to track one or multiple parcels at once using their tracking numbers.\n The result is the detailed tracking history provided for each tracking number separately\n ", "operationId": "getHistoryByTrackNumber", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParcelsHistoryRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryParcel" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "deprecated": true } }, "/date-range-history": { "post": { "tags": [ "Parcels" ], "summary": "Get parcels tracking by date range", "description": "\n This endpoint can be used to get the tracking event that occurred during the specified period of time.\n The result is the complete tracking events history grouped by tracking\n numbers with the events found in the requested timeframe\n ", "operationId": "getHistoryByDateRange", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateRangeParcelsHistoryRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryParcel" }, "deprecated": true }, "total_pages_count": { "type": "integer", "example": "35", "deprecated": true } }, "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "deprecated": true } }, "/pudo": { "post": { "tags": [ "Pudo" ], "summary": "Get PUDO list", "description": "Pick-up & Drop-off points", "operationId": "getPudoList", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "title": "PUDO id", "description": "ID of the pick-up drop-off point", "format": "string", "example": "1cfe311b-182e-4393-bbdc-3d7434889233" }, "title": { "title": "PUDO title", "description": "Title of the pick-up drop-off point", "format": "string", "example": "PE Station-AL-MALKI" }, "lat": { "title": "Latitude", "description": "Latitude of the pick-up drop-off point", "format": "float", "example": "24.584739" }, "lon": { "title": "Longitude", "description": "Longitude of the pick-up drop-off point", "format": "float", "example": "46.567153" }, "type": { "title": "Type", "description": "Type of the pick-up drop-off point", "format": "string", "enum": [ "STORE", "LOCKER", "POSTBOX", "POSTOFFICE" ] }, "distance": { "title": "Distance", "description": "Distance of the pick-up drop-off point, in km", "format": "float", "example": "10.56" }, "services": { "title": "Services", "description": "Array of supported by this PUDO services", "type": "array", "items": { "type": "string", "example": "DOM001" } }, "address": { "$ref": "#/components/schemas/PUDOAddress" }, "openingHours": { "title": "Opening hours", "description": "The time during is open for visitors", "properties": { "monday": { "type": "array", "items": { "type": "string", "example": [ "10:00-12:00", "13:00-20:00" ] } }, "tuesday": { "type": "array", "items": { "type": "string", "example": "10:00-20:00" } }, "wednesday": { "type": "array", "items": { "type": "string", "example": "10:00-20:00" } }, "thursday": { "type": "array", "items": { "type": "string", "example": "10:00-20:00" } }, "friday": { "type": "array", "items": { "type": "string", "example": "10:00-20:00" } }, "saturday": { "type": "array", "items": { "type": "string", "example": "10:00-20:00" } }, "sunday": { "type": "array", "items": { "type": "string", "example": "10:00-20:00" } } }, "type": "object" } }, "type": "object" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/shipments": { "post": { "tags": [ "Shipments" ], "summary": "Store new shipment", "description": "This endpoint can be used to register new shipments with parcels.", "operationId": "storeShipment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreShipmentRequest" } } } }, "responses": { "201": { "description": "Successful operation. Response format depends on the request.service.label_format.\nIf it's an array, multilabel response is returned", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ShipmentStoreResource" }, { "$ref": "#/components/schemas/ShipmentStoreMultiLabelResource" } ] } } } }, "422": { "description": "Request data validation failed." }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/shipments/{track_number}/recreate": { "post": { "tags": [ "Shipments" ], "summary": "Recreate shipment", "description": "This endpoint can be used to recreate shipment with parcels.", "operationId": "recreateShipment", "parameters": [ { "name": "track_number", "in": "path", "description": "Shipment track number", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecreateShipmentRequest" } } } }, "responses": { "200": { "description": "Successful operation. Response format depends on the request.service.label_format.\nIf it's an array, multilabel response is returned", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ShipmentStoreResource" }, { "$ref": "#/components/schemas/ShipmentStoreMultiLabelResource" } ] } } } }, "422": { "description": "Request data validation failed." }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/shipments/{track_number}/label?format={format}&api_key={api_key}": { "get": { "tags": [ "Shipments" ], "summary": "Retrieve shipment label", "description": "This endpoint can be used to retrieve the label after shipment has been created", "operationId": "getShipmentLabel", "parameters": [ { "name": "track_number", "in": "path", "description": "Shipment track number", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "path", "description": "Label format, defaults to PDF4x6", "required": false, "schema": { "type": "string", "enum": [ "PDF4x6", "PDF", "ZPL200", "ZPL300" ] } }, { "name": "api_key", "in": "path", "description": "API key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "x-application/zpl": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Request data validation failed." }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/shipments/{track_number}/?api_key={api_key}": { "get": { "tags": [ "Shipments" ], "summary": "Get shipment by track number", "description": "This endpoint can be used to get shipment with parcels by track number.", "operationId": "showShipment", "parameters": [ { "name": "track_number", "in": "path", "description": "Shipment track number", "required": true, "schema": { "type": "string" } }, { "name": "api_key", "in": "path", "description": "Api key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentResource" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/shipments/?api_key={api_key}&track_number={track_number}&order_reference={order_reference}": { "get": { "tags": [ "Shipments" ], "summary": "Search shipments", "description": "This endpoint can be used to search shipments by a criteria.", "operationId": "searchShipments", "parameters": [ { "name": "track_number", "in": "query", "description": "Shipment track number", "required": false, "schema": { "type": "string" } }, { "name": "order_reference", "in": "query", "description": "Shipment order reference", "required": false, "schema": { "type": "string" } }, { "name": "api_key", "in": "query", "description": "Api key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentResource" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/shipments/{track_number}/cancel?api_key={api_key}": { "post": { "tags": [ "Shipments" ], "summary": "Cancel shipment by track number", "description": "This endpoint can be used to cancel shipment with parcels by track number.", "operationId": "cancelShipment", "parameters": [ { "name": "track_number", "in": "path", "description": "Shipment track number", "required": true, "schema": { "type": "string" } }, { "name": "api_key", "in": "path", "description": "Api key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "message": { "format": "string", "example": "Canceled" } }, "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/shipments/{track_number}/address": { "post": { "tags": [ "Shipments" ], "summary": "Update shipment consignee (or shipper for return) address", "description": "This endpoint can be used to update shipment (or shipper for return) address", "operationId": "updateAddress", "parameters": [ { "name": "track_number", "in": "path", "description": "Shipment track number", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateAddressRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "message": { "format": "string", "example": "Address updated" } }, "type": "object" } } } }, "422": { "description": "Request data validation failed." }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/shipments/{track_number}/reschedule": { "post": { "tags": [ "Shipments" ], "summary": "Update shipment scheduled delivery date", "description": "This endpoint can be used to update shipment scheduled delivery date", "operationId": "rescheduleDelivery", "parameters": [ { "name": "track_number", "in": "path", "description": "Shipment track number", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryRescheduleRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "message": { "format": "string", "example": "Delivery rescheduled succesfully" } }, "type": "object" } } } }, "422": { "description": "Request data validation failed." }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/shipments/{track_number}/refuse": { "post": { "tags": [ "Shipments" ], "summary": "Refuse shipment delivery", "description": "This endpoint can be used to refuse shipment delivery", "operationId": "deliveryRefuse", "parameters": [ { "name": "track_number", "in": "path", "description": "Shipment track number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "message": { "format": "string", "example": "Delivery refused succesfully" } }, "type": "object" } } } }, "422": { "description": "Request data validation failed." }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/shipment/history": { "get": { "tags": [ "Shipments" ], "summary": "Get single shipment tracking history.", "description": "Should be used to obtain all tracking history using\n shipment tracking number. One shipment per request.", "operationId": "shipmentHistory", "parameters": [ { "name": "api_key", "in": "query", "description": "API Key", "required": true, "schema": { "type": "string" } }, { "name": "tracking_number", "in": "query", "description": "Shipment tracking number to track.", "required": true, "schema": { "type": "string", "example": "000000000012637" } } ], "responses": { "200": { "description": "Operation was successfull", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation failed" }, "500": { "description": "Internal server error" } } } } }, "components": { "schemas": { "StoreShipsyRequest": { "required": [ "customer_code", "service_type_id", "origin_details", "destination_details", "pieces_detail" ], "properties": { "customer_code": { "description": "Customer code defined in Shipsy", "type": "string", "example": "SHIPSY" }, "service_type_id": { "description": "Service type ID of consignment defined in Shipsy", "type": "string", "example": "STANDARD" }, "action_type": { "description": "Manifestation process handling. Allowed types ('delivery', 'inscan', 'Single_pickup')", "type": "string", "example": "single_pickup", "nullable": true }, "consignment_type": { "description": "Consignment Type. Allowed types ('forward', 'reverse')", "type": "string", "example": "forward", "nullable": true }, "movement_type": { "description": "Movement Type of the consignment.\nAllowed: (“forward”, 'rts', 'rto', 'rtv', 'rvp', 'forward', 'reverse')", "type": "string", "example": "forward" }, "verify_otp_on_delivery": { "description": "Determines whether OTP verification is required during delivery or not.", "type": "string", "example": true, "nullable": true }, "eway_bill": { "description": "Eway Bill Number of Consignment", "type": "string", "example": "12878382929", "nullable": true }, "load_type": { "description": "load type for the consignment. Allowed: ('DOCUMENT', 'NON-DOCUMENT').\nDefault is 'NON-DOCUMENT'.", "type": "string", "example": "DOCUMENT", "nullable": true }, "description": { "description": "description of the consignment.", "type": "string", "example": "Notebook", "nullable": true }, "reference_number": { "description": "Unique number of a consignment in Shipsy", "type": "string", "example": "E12345678", "nullable": true }, "cod_favor_of": { "description": "Details of the entity in whose name collection is to be made", "type": "string", "example": "Ram Manohar", "nullable": true }, "cod_collection_mode": { "description": "COD collection mode. Allowed (“cash”, “cheque”, “dd”)", "type": "string", "example": "cheque", "nullable": true }, "dimension_unit": { "description": "Unit for dimensions of peice. Allowed: 'cm', 'in', 'mm', 'm'. default is 'cm'", "type": "string", "example": "in", "nullable": true }, "length": { "description": "Length of consignment (cm)", "type": "string", "example": "5", "nullable": true }, "width": { "description": "Width of consignment (cm)", "type": "string", "example": "10", "nullable": true }, "height": { "description": "Height of consignment (cm)", "type": "string", "example": "20", "nullable": true }, "weight_unit": { "description": "Unit of Weight.Optional Allowed:\n 'gm', 'kg', 'kt', 'lb', 'mg', 'oz', 'to', 'ton'. Default is 'kg'.", "type": "string", "example": "gm", "nullable": true }, "volume": { "description": "Volume of consignment", "type": "string", "example": "100", "nullable": true }, "volume_unit": { "description": "Unit of volume. Allowed:\n'ccm', 'cd3', 'cl', 'foz', 'ft3', 'gal', 'hl', 'l', 'ml', 'mm3', 'pt, 'qt', 'yd3', 'mmq', 'µl'. Default is 'cm3'", "type": "string", "example": "cm3", "nullable": true }, "weight": { "description": "Weight of consignment", "type": "string", "example": "0.25", "nullable": true }, "cod_amount": { "description": "COD amount to be collected for the consignment under consideration", "type": "string", "example": "100", "nullable": true }, "invoice_amount": { "description": "Invoice Amount", "type": "string", "example": "100", "nullable": true }, "invoice_number": { "description": "Invoice Number of Consignment", "type": "string", "example": "C3447827878470", "nullable": true }, "invoice_date": { "description": "Invoice Date of Consignment. Acceptable format: YYYY-MM-DD", "type": "string", "example": "2022-09-07", "nullable": true }, "declared_value": { "description": "Declared value of consignment. Also accepted as an Integer", "type": "string", "example": "2800", "nullable": true }, "declared_value_without_tax": { "description": "Base value of consignment. Also accepted as an Integer", "type": "string", "example": "2800", "nullable": true }, "currency": { "description": "Currency of consignment", "type": "string", "example": "SAR", "nullable": true }, "product_code": { "description": "Product code for predefined product categories.\nEach product with a given product code will have its predefined dimensions and weight defined in Shipsy system.\nRemark: Load_type should be NON-DOCUMENT for this. If present, dimension and weight values will be overwritten with\nthe product code mapping. No need to provide dimension_unit, length, width, height, weight_unit, weight.", "type": "string", "example": "PL00123345", "nullable": true }, "num_pieces": { "description": "Number of pieces of Consignment. Also accepted as an Integer", "type": "string", "example": "10", "nullable": true }, "customer_reference_number": { "description": "Customer reference number", "type": "string", "example": "ABCD", "nullable": true }, "is_risk_surcharge_applicable": { "description": "Risk surcharge applicable", "type": "string", "example": false, "nullable": true }, "service_code": { "description": "Service Code if there are any additional services for the Consignment", "type": "string", "example": "Insurance", "nullable": true }, "courier_partner": { "description": "Courier Partner", "type": "string", "example": "Shadowfax", "nullable": true }, "courier_account": { "description": "Courier Account Name", "type": "string", "example": "Shadowfax Instant", "nullable": true }, "courier_partner_reference_number": { "description": "Courier Partner Reference number/AWB Number of the consignment", "type": "string", "example": "301458690", "nullable": true }, "hub_code": { "description": "Order Manifestation Hub Code", "type": "string", "example": "FB100", "nullable": true }, "inco_terms": { "description": "Incoterm defines the business terms of trade", "type": "string", "example": "DDU", "nullable": true }, "notes": { "description": "Any notes that adds relevant information to the consignment", "type": "string", "example": "Testing Note", "nullable": true }, "reference_image_url": { "description": "Reference Image of the Consignment", "type": "string", "example": "https://shipsy-public-assets.s3.amazonaws.com/shipsyflamingo/logo.png", "nullable": true }, "constraint_tags": { "description": "Constraint for the consignment", "type": "array", "items": { "type": "string", "example": "Chilled" }, "nullable": true }, "customs_value": { "description": "Customs Value Object", "properties": { "amount": { "description": "Customs Amount", "type": "string", "example": "100", "nullable": true }, "currency": { "description": "Customs Currency", "type": "string", "example": "USD", "nullable": true } }, "type": "object", "nullable": true }, "additional_properties": { "description": "Add Consignment Client SoftData Upload Additional Properties Details", "properties": { "ioss_number": { "description": "“Import One Stop Shop” number relevant for orders in the EU. 12 Digit alphanumeric code", "type": "string", "example": "FR275815987", "nullable": true }, "ad_code": { "description": "AD code of the exported given by the bank. 14 digit code", "type": "string", "example": "1234567890123", "nullable": true }, "meis_applicable": { "description": "Merchandise Exports from India Scheme” applicability on the piece", "type": "boolean", "example": false, "nullable": true }, "hsn_code": { "description": "HSN Code of the piece", "type": "string", "example": "123456", "nullable": true } }, "type": "object", "nullable": true }, "tax_details": { "description": "Tax details of the Consignment", "properties": { "cgst": { "description": "Central GST Value. Optional", "type": "string", "example": "0.0", "nullable": true }, "sgst": { "description": "State GST Value. Optional", "type": "string", "example": "0.0", "nullable": true }, "igst": { "description": "Integrated GST Value. Optional", "type": "string", "example": "0.0", "nullable": true }, "total_tax": { "description": "Total Tax applicable. Optional", "type": "string", "example": "0.0", "nullable": true }, "sender_gstin": { "description": "GST number of the sender. Optional", "type": "string", "example": "22AAAAA0000A1Z4", "nullable": true }, "receiver_gstin": { "description": "GST number of the receiver. Optional", "type": "string", "example": "22AAAAA0000A1Z4", "nullable": true } }, "type": "object", "nullable": true }, "delivery_time_slot_start": { "description": "Delivery Slot Start Time. Acceptable format: YYYY-MM-DD HH:mm:ss", "type": "string", "example": "2021-11-12 14:05:36", "nullable": true }, "delivery_time_slot_end": { "description": "Delivery Slot End Time. Acceptable format: YYYY-MM-DD HH:mm:ss", "type": "string", "example": "2021-10-30 09:55:40", "nullable": true }, "scheduled_at": { "description": "The delivery date on which the CN would be planned for. Acceptable format: 'YYYY-MM-DD'", "type": "string", "example": "2021-11-12", "nullable": true }, "service_time": { "description": "Time taken for completing the delivery (in Seconds)", "type": "integer", "example": 1200, "nullable": true }, "origin_details": { "description": "Add Consignment Client SoftData Upload Consignment Address", "required": [ "name", "phone", "address_line_1", "pincode", "country", "city" ], "properties": { "address_hub_code": { "description": "Hub code to fetch the address details from Shipsy system.\nRemark: If address_hub_code is defined then address details are fetched from this and passed values with\noverwrite these. In case of incorrect value and error will be shown", "type": "string", "example": "GGN002", "nullable": true }, "account_id": { "description": "Account Number of the party", "type": "string", "example": "123456", "nullable": true }, "email": { "description": "Email Address", "type": "string", "example": "test@companyname.com", "nullable": true }, "company_name": { "description": "Company Name of the party", "type": "string", "example": "Global Logistics", "nullable": true }, "name": { "description": "Name of consignor (in case of origin) or Consignee (in case of destination)", "type": "string", "example": "Shipsy" }, "phone": { "description": "Phone number of Consignor (in case of origin) or Consignee (in case of destination)", "type": "string", "example": "9971149561" }, "alternate_phone": { "description": "Alternate Phone number of Consignor (in case of origin) or Consignee\n(in case of destination). Optional", "type": "string", "example": "8586999698", "nullable": true }, "address_line_1": { "description": "Address details of the Consignor (in case of origin) or Consignee\n(in case of destination). Optional", "type": "string", "example": "B-23 Sushant Lok I" }, "address_line_2": { "description": "Address details of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Opp. Bestech Centre Point Mall", "nullable": true }, "pincode": { "description": "Pincode details of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "122009" }, "district": { "description": "District of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Jeddah", "nullable": true }, "city": { "description": "City of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Jeddah", "nullable": true }, "state": { "description": "State of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Jeddah", "nullable": true }, "country": { "description": "Country of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "SA", "nullable": true }, "latitude": { "description": "Latitude of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "34.288", "nullable": true }, "longitude": { "description": "Longitude of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "34.288", "nullable": true } }, "type": "object", "nullable": true }, "destination_details": { "description": "Add Consignment Client SoftData Upload Consignment Address", "required": [ "name", "phone", "address_line_1", "pincode", "country", "city" ], "properties": { "address_hub_code": { "description": "Hub code to fetch the address details from Shipsy system.\nRemark: If address_hub_code is defined then address details are fetched from this and passed values\nwith overwrite these. In case of incorrect value and error will be shown", "type": "string", "example": "GGN002", "nullable": true }, "account_id": { "description": "Account Number of the party", "type": "string", "example": "123456", "nullable": true }, "email": { "description": "Email Address", "type": "string", "example": "test@companyname.com", "nullable": true }, "company_name": { "description": "Company Name of the party", "type": "string", "example": "Global Logistics", "nullable": true }, "name": { "description": "Name of consignor (in case of origin) or Consignee (in case of destination)", "type": "string", "example": "Shipsy" }, "phone": { "description": "Phone number of Consignor (in case of origin) or Consignee (in case of destination)", "type": "string", "example": "9971149561" }, "alternate_phone": { "description": "Alternate Phone number of Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "8586999698", "nullable": true }, "address_line_1": { "description": "Address details of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "B-23 Sushant Lok I" }, "address_line_2": { "description": "Address details of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Opp. Bestech Centre Point Mall", "nullable": true }, "pincode": { "description": "Pincode details of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "122009" }, "district": { "description": "District of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Riyadh", "nullable": true }, "city": { "description": "City of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Riyadh", "nullable": true }, "state": { "description": "State of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Riyadh", "nullable": true }, "country": { "description": "Country of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "SA", "nullable": true }, "latitude": { "description": "Latitude of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "34.288", "nullable": true }, "longitude": { "description": "Longitude of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "34.288", "nullable": true } }, "type": "object", "nullable": true }, "nodes": { "description": "Details for hub nodes present in journey", "type": "array", "items": { "required": [ "courier_partner", "courier_accounts", "declared_value", "mode", "node_type" ], "properties": { "courier_partner": { "description": "Courier partner for leg of journey originating from that node", "type": "string", "example": "BLUEDART" }, "courier_accounts": { "description": "Account name for that leg of journey", "type": "string", "example": "Bluedart_ggn_mum" }, "declared_value": { "description": "Declared Value of the Consignment", "type": "string", "example": "100" }, "mode": { "description": "The mode for transport, Acceptable values: shipment, bag", "type": "string", "example": "shipment" }, "node_type": { "description": "Leg of the CN journey, Acceptable values: FM, MM, LM", "type": "string", "example": "FM" } }, "type": "object" }, "nullable": true }, "return_details": { "description": "Add Consignment Client SoftData Upload Consignment Address", "required": [ "name", "phone", "address_line_1", "pincode" ], "properties": { "address_hub_code": { "description": "Hub code to fetch the address details from Shipsy system.\n Remark: If address_hub_code is defined then address details are fetched from this and passed values with\n overwrite these. In case of incorrect value and error will be shown", "type": "string", "example": "GGN002", "nullable": true }, "account_id": { "description": "Account Number of the party", "type": "string", "example": "123456", "nullable": true }, "email": { "description": "Email Address", "type": "string", "example": "test@companyname.com", "nullable": true }, "company_name": { "description": "Company Name of the party", "type": "string", "example": "Global Logistics", "nullable": true }, "name": { "description": "Name of consignor (in case of origin) or Consignee (in case of destination)", "type": "string", "example": "Shipsy" }, "phone": { "description": "Phone number of Consignor (in case of origin) or Consignee (in case of destination)", "type": "string", "example": "9971149561" }, "alternate_phone": { "description": "Alternate Phone number of Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "8586999698", "nullable": true }, "address_line_1": { "description": "Address details of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "B-23 Sushant Lok I" }, "address_line_2": { "description": "Address details of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Opp. Bestech Centre Point Mall", "nullable": true }, "pincode": { "description": "Pincode details of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "122009" }, "district": { "description": "District of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Gurgaon", "nullable": true }, "city": { "description": "City of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Gurgaon", "nullable": true }, "state": { "description": "State of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "Haryana", "nullable": true }, "country": { "description": "Country of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "India", "nullable": true }, "latitude": { "description": "Latitude of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "34.288", "nullable": true }, "longitude": { "description": "Longitude of the Consignor (in case of origin) or\nConsignee (in case of destination). Optional", "type": "string", "example": "34.288", "nullable": true } }, "type": "object", "nullable": true }, "pieces_detail": { "description": "Consignment Piece Details", "type": "array", "items": { "required": [ "description", "weight", "height", "length", "width" ], "properties": { "description": { "description": "Piece Description of Consignment Piece. Optional", "type": "string", "example": "Notebook", "nullable": true }, "declared_value": { "description": "Declared value of Consignment Piece. Required in pieces_details for NON-DOCUMENT", "type": "string", "example": "100", "nullable": true }, "volume": { "description": "Volume of consignment", "type": "string", "example": "100", "nullable": true }, "weight": { "description": "Weight of consignment piece (kg). Required in pieces_details for NON-DOCUMENT", "type": "string", "example": "1.5", "nullable": true }, "height": { "description": "Height of consignment piece (cm). Required in pieces_details for NON-DOCUMENT", "type": "string", "example": "1.5", "nullable": true }, "length": { "description": "Length of consignment piece (cm). Required in pieces_details for NON-DOCUMENT", "type": "string", "example": "1.5", "nullable": true }, "width": { "description": "Width of consignment piece (cm). Required in pieces_details for NON-DOCUMENT", "type": "string", "example": "1.5", "nullable": true }, "quantity": { "description": "Quantity of consignment piece", "type": "string", "example": "1", "nullable": true }, "weight_unit": { "description": "Unit of Weight.Optional Allowed:\n'gm', 'kg', 'kt', 'lb', 'mg', 'oz', 'to', 'ton'. Default is 'kg'.", "type": "string", "example": "kg", "nullable": true }, "dimension_unit": { "description": "Unit for dimensions of peice. Allowed: 'cm', 'in', 'mm', 'm'. default is 'cm'", "type": "string", "example": "in", "nullable": true }, "volume_unit": { "description": "Unit of volume. Allowed:\n'ccm', 'cd3', 'cl', 'foz', 'ft3', 'gal', 'hl', 'l', 'ml', 'mm3', 'pt, 'qt', 'yd3', 'mmq', 'µl'. Default is 'cm3'", "type": "string", "example": "MMQ", "nullable": true }, "piece_product_code": { "description": "Product Code of the piece", "type": "string", "example": "PLL0010029291", "nullable": true }, "reference_image_url": { "description": "Reference Image of the Piece", "type": "string", "example": "https://shipsy-public-assets.s3.amazonaws.com/shipsyflamingo/logo.png", "nullable": true }, "additional_properties": { "description": "Add Consignment Client SoftData Upload Additional Properties Details", "properties": { "ioss_number": { "description": "“Import One Stop Shop” number relevant for\norders in the EU. 12 Digit alphanumeric code", "type": "string", "example": "FR275815987", "nullable": true }, "ad_code": { "description": "AD code of the exported given by the bank. 14 digit code", "type": "string", "example": "1234567890123", "nullable": true }, "meis_applicable": { "description": "Merchandise Exports from India Scheme applicability on the piece", "type": "boolean", "example": false }, "hsn_code": { "description": "HSN Code of the piece", "type": "string", "example": "123456", "nullable": true } }, "type": "object", "nullable": true } }, "type": "object" } } }, "type": "object" }, "TrackShipsyRequest": { "required": [ "reference_number_list" ], "properties": { "reference_number_list": { "description": "Track number of the shipment", "type": "array", "items": { "type": "string", "example": "AE1234456" }, "nullable": false } }, "type": "object" }, "ListCitiesRequest": { "required": [ "country" ], "properties": { "country": { "description": "Country code", "type": "string", "example": "SA" } }, "type": "object" }, "LoginRequest": { "title": "Login Request", "required": [ "phone_email", "code" ], "properties": { "phone_email": { "title": "Phone number or email", "type": "string", "example": "+380990001122" }, "code": { "title": "Code from sms", "type": "string", "example": "1234" } }, "type": "object" }, "SendCodeForParcel": { "title": "Send code", "required": [ "phone", "trackNumber" ], "properties": { "phone": { "title": "Phone number", "type": "string", "example": "+380990001122" }, "trackNumber": { "title": "track number", "type": "string", "example": "S0000022024" }, "f_emulate": { "title": "f_emulate", "type": "integer", "enum": [ 0, 1 ], "example": 1 } }, "type": "object" }, "SendCodeRequest": { "title": "Send SMS", "required": [ "phone_email" ], "properties": { "phone_email": { "title": "Phone number or email", "type": "string", "example": "+380990001122" }, "f_emulate": { "title": "f_emulate", "type": "integer", "enum": [ 0, 1 ], "example": 1 } }, "type": "object" }, "ClientStoreImageRequest": { "title": "Store image request", "required": [ "data" ], "properties": { "data": { "title": "Image data URI", "type": "string", "example": "data:image/png;base64,iVBORw0KGgoAAA\nANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4\n//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU\n5ErkJggg==" }, "name": { "title": "Image name.", "type": "string", "example": "whatever.png" }, "tags": { "title": "Tags for image which can be used for searching.", "type": "string", "example": "tag1,tag2,tag3" }, "comments": { "title": "Comments to the image.", "type": "string", "example": "Have a nice day!" } }, "type": "object" }, "DeleteImagesRequest": { "title": "Delete images.", "description": "Delete images by image id array", "properties": { "list": { "title": "Unique image identifier.", "type": "string", "example": "[1, 2]" } }, "type": "object" }, "GetClientImageRequest": { "title": "Get images request.", "description": "At least one of the parameter should be present in the request.", "properties": { "image_key": { "title": "Unique image identifier.", "type": "string", "example": "21f24846c8d0c98cda98a54483fb6c516bd6a36d1f4f572525af1ed3e76f7161" }, "tag": { "title": "Tag assigned to the image(-s).", "type": "string", "example": "tag1" } }, "type": "object" }, "UpdateImageClientRequest": { "title": "Update image request.", "description": "At least one of the parameter should be present in the request.", "properties": { "id": { "title": "Image ID", "type": "string", "example": "10" }, "tags": { "title": "Tags assigned to the image", "type": "string", "example": "tag1,tag2,tag3" }, "comments": { "title": "Comments to image", "type": "string", "example": "tag1,tag2,tag3" } }, "type": "object" }, "GetParcelLocationRequest": { "required": [ "track_number" ], "properties": { "track_number": { "description": "Parcel`s tracking number.", "type": "string", "example": "TRC_1234" } }, "type": "object" }, "ParcelsInfoRequest": { "title": "ParcelsInfoRequest", "description": "Displays information about the parcel", "properties": { "track_number": { "title": "track_number", "example": "S0000021946" }, "history": { "title": "history", "example": "1" } }, "type": "object" }, "ParcelsListRequest": { "title": "ParcelsListRequest", "description": "Displays list of parcels by filter", "required": [ "date_from", "date_to" ], "properties": { "date_from": { "title": "Date from", "type": "string", "example": "2022-05-01" }, "date_to": { "title": "Date to", "type": "string", "example": "2022-10-15" }, "status": { "title": "Status", "type": "integer", "example": "300" } }, "type": "object" }, "EmailCheckRequest": { "title": "EmailCheckRequest", "properties": { "email": { "title": "email", "example": "testtest@test.com" } }, "type": "object" }, "EmailSetRequest": { "title": "EmailSetRequest", "properties": { "email": { "title": "email", "example": "testtest@test.com" }, "code": { "title": "code", "example": "1234" } }, "type": "object" }, "ExtraEmailCheckRequest": { "title": "ExtraEmailCheckRequest", "properties": { "email": { "title": "email", "example": "testtest@test.com" } }, "type": "object" }, "ExtraEmailDeleteRequest": { "title": "ExtraEmailDeleteRequest", "properties": { "email": { "title": "email", "example": "testtest@test.com" } }, "type": "object" }, "ExtraEmailSetRequest": { "title": "ExtraEmailSetRequest", "properties": { "email": { "title": "email", "example": "testtest@test.com" }, "code": { "title": "code", "example": "1234" } }, "type": "object" }, "ExtraPhoneCheckRequest": { "title": "ExtraPhoneCheckRequest", "properties": { "phone": { "title": "phone", "example": "+380971112233" } }, "type": "object" }, "ExtraPhoneDeleteRequest": { "title": "ExtraPhoneDeleteRequest", "properties": { "phone": { "title": "phone", "example": "+380971112233" } }, "type": "object" }, "ExtraPhoneSetRequest": { "title": "ExtraPhoneSetRequest", "properties": { "phone": { "title": "phone", "example": "+380971112233" }, "code": { "title": "code", "example": "1234" } }, "type": "object" }, "PhoneCheckRequest": { "title": "PhoneCheckRequest", "properties": { "phone": { "title": "phone", "example": "+380971112233" } }, "type": "object" }, "PhoneSetRequest": { "title": "PhoneCheckRequest", "properties": { "phone": { "title": "phone", "example": "+380971112233" }, "code": { "title": "code", "example": "2345" } }, "type": "object" }, "UpdateRequest": { "title": "Update profile", "properties": { "birth_day": { "title": "Birth day", "example": "1990-01-01" }, "name": { "title": "Name", "example": "Mark" } }, "type": "object" }, "UpdateSettingsRequest": { "title": "Update client settings", "properties": { "language": { "title": "Language", "example": "en" } }, "type": "object" }, "ListCities": { "title": "SearchInList", "description": "PUDO client request body data", "properties": { "country": { "title": "Country", "description": "Country code", "type": "string", "format": "string", "default": "", "example": "SA" } }, "type": "object" }, "SearchInList": { "title": "SearchInList", "description": "PUDO client request body data", "properties": { "is_test": { "title": "Test flag", "description": "Test flag, set as true if you want to test the payload", "type": "string", "example": "true" }, "type": { "title": "Type", "description": "Find PUDOs of choosen type (STORE, LOCKER, etc)", "type": "string", "format": "string", "default": "", "example": "store" }, "distance": { "title": "Distance", "description": "Find points by coordinates within a distance in kilometers", "type": "integer", "format": "int", "default": 10, "example": 10 }, "address": { "$ref": "#/components/schemas/SearchPUDOAddress" } }, "type": "object" }, "GetShipmentLocationRequest": { "required": [ "track_number" ], "properties": { "track_number": { "description": "Shipment`s tracking.", "type": "string", "example": "TRC_1234" } }, "type": "object" }, "ShipmentInfoRequest": { "title": "ShipmentInfoRequest", "description": "Displays information about the shipment", "properties": { "track_number": { "title": "track_number", "example": "S0000021946" }, "history": { "title": "history", "example": "1" } }, "type": "object" }, "UpdateAddressRequest": { "title": "UpdateAddressRequest", "properties": { "track_number": { "title": "track_number", "example": "S0000021931" }, "address1": { "title": "Address line 1", "example": "Some Street" }, "address2": { "title": "Address line 2", "example": "apt. 1" }, "address3": { "title": "Address line 3", "example": "left corner" } }, "type": "object" }, "UpdateGeoRequest": { "title": "UpdateGeoRequest", "properties": { "track_number": { "title": "track_number", "example": "S0000021931" }, "latitude": { "title": "latitude", "example": "50.9011" }, "longitude": { "title": "longitude", "example": "40.9011" } }, "type": "object" }, "UpdateNotesRequest": { "title": "UpdateNotesRequest", "properties": { "track_number": { "title": "track_number", "example": "S0000021931" }, "images[]": { "title": "images[]", "example": "" }, "comment": { "title": "comment", "example": "" } }, "type": "object" }, "ShipmentUpdateRequest": { "title": "UpdateShipmentRequest", "properties": { "track_number": { "title": "track_number", "example": "S0000021931" } }, "type": "object" }, "ShipmentsListRequest": { "title": "ShipmentsListRequest", "description": "Displays list of shipments by filter", "required": [ "date_from", "date_to" ], "properties": { "date_from": { "title": "Date from", "type": "string", "example": "2022-05-01" }, "date_to": { "title": "Date to", "type": "string", "example": "2022-10-15" }, "status": { "title": "Status", "type": "integer", "example": "300" } }, "type": "object" }, "CancelParcelRequest": { "title": "Cancel Parcel", "description": "Cancel parcel request body data", "required": [ "name" ], "properties": { "api_key": { "title": "Api key", "description": "Users api key", "type": "string", "example": "AAA" }, "tracking_numbers": { "title": "Parcels tracking numbers", "description": "Array of parcel tracking numbers", "type": "array", "items": { "type": "string", "example": "000000000012637" } } }, "type": "object" }, "DateRangeParcelsHistoryRequest": { "title": "Parcels History request by date range", "description": "Parcels History request body data by date range", "required": [ "api_key", "date_from", "date_to" ], "properties": { "api_key": { "title": "Api key", "description": "Users api key", "type": "string", "example": "AAA" }, "date_from": { "title": "Date from", "description": "Start date/time of tracking history", "type": "string", "example": "2020-09-22 00:00:00" }, "date_to": { "title": "Date to", "description": "End date/time of tracking history", "type": "string", "example": "2020-09-25 23:59:59" }, "per_page": { "title": "Per page", "description": "Events on page", "type": "integer", "example": "24" }, "page": { "title": "Page", "description": "Page number", "type": "integer", "default": "1" } }, "type": "object" }, "HistoryParcel": { "title": "Parcels History", "description": "History events of parcel", "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PackageHistory" }, "x-additionalPropertiesName": "$tracking_number" } }, "ParcelBaseRequest": { "title": "Store Parcel request", "description": "Store Parcel request body data", "required": [ "name", "api_key", "service_code", "consignee_name", "consignee_country", "consignee_city", "consignee_address1", "consignee_phone", "shipper_name", "shipper_country", "shipper_city", "shipper_zip", "shipper_address1", "weight", "products" ], "properties": { "is_test": { "title": "Test flag", "description": "Test flag, set as true if you want to test the payload", "type": "string", "example": "true" }, "api_key": { "title": "Api key", "description": "Users api key", "type": "string", "format": "string", "example": "AAA" }, "service": { "$ref": "#/components/schemas/Service" }, "package": { "$ref": "#/components/schemas/Package" }, "consignee_address": { "$ref": "#/components/schemas/ConsigneeAddress" }, "shipper_address": { "$ref": "#/components/schemas/ShipperAddress" }, "products": { "title": "Products", "type": "array", "items": { "$ref": "#/components/schemas/ParcelItem" } } }, "type": "object" }, "ParcelsHistoryRequest": { "title": "Parcels History request", "description": "Parcels History request body data", "required": [ "name" ], "properties": { "api_key": { "title": "Api key", "description": "Users api key", "type": "string", "example": "1111AAA" }, "tracking_numbers": { "title": "Parcels tracking numbers", "description": "Array of parcel tracking numbers", "type": "array", "items": { "type": "string", "example": "000000000012637" } } }, "type": "object" }, "StoreParcel": { "title": "Store Parcel request", "description": "Store Parcel request body data", "required": [ "name", "is_test", "api_key", "service_code", "consignee_name", "consignee_country", "consignee_city", "consignee_address1", "consignee_phone", "shipper_name", "shipper_country", "shipper_city", "shipper_zip", "shipper_address1", "shipper_phone", "weight", "products" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ParcelBaseRequest" } ] }, "StoreParcelGroup": { "title": "Store Parcel Group request", "description": "Store Parcel Group request body data", "required": [ "parcel_group_data", "is_test", "api_key" ], "properties": { "is_test": { "title": "Test flag", "description": "Test flag, set as true if you want to test the payload", "type": "string", "example": "true" }, "api_key": { "title": "Api key", "description": "Warehouse Operator / Shipper User api key", "type": "string", "format": "string", "example": "12345" }, "parcel_group_data": { "$ref": "#/components/schemas/ParcelGroupData" } }, "type": "object" }, "GetListRequest": { "title": "PUDO request", "description": "PUDO request body data", "required": [ "is_test", "api_key" ], "properties": { "is_test": { "title": "Test flag", "description": "Test flag, set as true if you want to test the payload", "type": "string", "example": "true" }, "api_key": { "title": "Api key", "description": "Warehouse Operator / Shipper User api key", "type": "string", "format": "string", "example": "12345" }, "distance": { "title": "Distance", "description": "Find points by coordinates within a distance in kilometers", "type": "integer", "format": "int", "default": 10, "example": 10 }, "address": { "$ref": "#/components/schemas/SearchPUDOAddress" } }, "type": "object" }, "DeliveryRescheduleRequest": { "title": "Update shipment scheduled delivery date", "description": "Update shipment shipment scheduled delivery date request body data", "required": [ "scheduled_delivery_date" ], "properties": { "scheduled_delivery_date": { "title": "Scheduled delivery date", "description": "Scheduled delivery date (should be future date)", "type": "string", "example": "2025-02-20 10:10" } }, "type": "object" }, "RecreateShipmentRequest": { "title": "Recreate Shipment request", "description": "Recreate Shipment request body data", "required": [ "is_test", "api_key", "incoterm", "parcels", "service", "consignee_address", "shipper_address", "track_number" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ShipmentBaseRequest" }, { "properties": { "track_number": { "title": "Tracking number", "description": "Tracking number generated and provided by the customer.", "type": "string", "format": "string", "example": "QQ0000001SF" }, "parcels": { "title": "Parcels", "type": "array", "items": { "$ref": "#/components/schemas/ShipmentRecreateParcelItem" } } }, "type": "object" } ] }, "ShipmentBaseRequest": { "properties": { "is_test": { "title": "Test flag", "description": "Test flag, set as true if you want to test the payload", "type": "string", "example": "true" }, "api_key": { "title": "Api key", "description": "Users api key", "type": "string", "format": "string", "example": "AAA" }, "include": { "title": "Control optional response fields", "description": "A set of flags to control what optional response fields are included", "properties": { "labelURI": { "description": "Return shipment label URI, defaults to `false`", "type": "boolean" } }, "type": "object" }, "order_reference": { "title": "Order reference", "description": "Order reference. This can be your order number or ID", "type": "string", "format": "string", "minLength": 3, "example": "A9900001" }, "customer_id_reference": { "title": "Customer Id Reference", "description": "Unique reference provided by the customer.", "type": "string", "format": "string", "example": "TEZQFUZJFI" }, "invoice": { "title": "Invoice number", "description": "Invoice number", "type": "string", "format": "string", "example": "AB12221241" }, "description": { "title": "Shipment description", "description": "Description of the shipment contents", "type": "string", "format": "string", "example": "Black leather jacket" }, "rgr_number": { "title": "RGR number", "description": "\nReturned Goods Relief number.\nSubject to specific conditions, Returned Goods Relief (RGR) removes or reduces\nthe repayment of import duties for goods that are re-imported into the same\ncustoms territory that they have already been exported from.\n * ", "type": "string", "format": "string", "example": "QS12344411DN" }, "export_entry_number": { "title": "Export entry number", "description": "Customs export entry number.", "type": "string", "format": "string", "example": "QS12344411DN" }, "incoterm": { "title": "Incoterm", "description": "International Commercial Term.", "type": "string", "format": "string", "enum": [ "DDU", "DDP" ], "example": "DDU" }, "value": { "title": "Parcel value", "description": "Total parcel value", "type": "number", "format": "double", "example": "29.99" }, "currency": { "title": "Parcel currency", "description": "Currency", "type": "string", "format": "string", "example": "SAR" }, "cod_value": { "title": "COD value", "description": "The amount to pay for Cash on delivery", "type": "number", "format": "double", "example": "29.99" }, "cod_currency": { "title": "COD currency", "description": "Cash on delivery currency", "type": "string", "format": "string", "example": "SAR" }, "is_dangerous": { "title": "Dangerous Goods", "description": "Partcel with dangerous goods", "type": "boolean", "example": "1" }, "category": { "title": "Parcel category", "description": "Parcel category", "type": "string", "enum": [ "commercial_goods", "gifts", "documents", "commercial_sample", "returned_goods", "other", "clothing", "intercompany_transfer", "repair", "personal_items" ], "example": "commercial_goods" }, "service": { "$ref": "#/components/schemas/ShipmentService" }, "consignee_address": { "$ref": "#/components/schemas/ConsigneeAddress" }, "shipper_address": { "$ref": "#/components/schemas/ShipperAddress" } }, "type": "object" }, "ShipmentUpdateAddressRequest": { "title": "Update shipment consignee (or shipper for return) address", "description": "Update shipment consignee (or shipper for return) address request body data", "required": [], "properties": { "consignee_name": { "title": "Consignee name", "description": "Consignee name", "type": "string", "maxLength": 35, "example": "John Smith" }, "consignee_company": { "title": "Consignee company", "description": "Consignee company name", "type": "string", "maxLength": 35, "example": "" }, "consignee_address1": { "title": "Consignee address line 1", "description": "Consignee address line 1", "type": "string", "example": "Al Murabba" }, "consignee_address2": { "title": "Consignee address line 2", "description": "Consignee address line 2", "type": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd" }, "consignee_address3": { "title": "Consignee address line 3", "description": "Consignee address line 3. Rarely used", "type": "string", "example": "" }, "consignee_country": { "title": "Consignee country", "description": "Consignee country code (ISO 3166-1, Alpha-2 code):\n- For Domestic shipments can be SA only\n- For International shipments can be SA only\n * ", "type": "string", "maxLength": 2, "minLength": 2, "example": "SA" }, "consignee_city": { "title": "Consignee city", "description": "Consignee city", "type": "string", "example": "Riyadh" }, "consignee_state": { "title": "Consignee state", "description": "Consignee state", "type": "string", "maxLength": 100, "example": "Riyadh" }, "consignee_zip": { "title": "Consignee zip", "description": "Consignee zip", "type": "string", "maxLength": 35, "example": "" }, "consignee_phone": { "title": "Consignee phone", "description": "Consignee phone", "type": "string", "example": "+966 011 123 4566" }, "consignee_email": { "title": "Consignee email", "description": "Consignee email", "type": "string", "example": "John@mail.net" }, "consignee_vat": { "title": "Consignee VAT", "description": "Consignee VAT number", "type": "string", "example": "32197482341410" }, "consignee_lat": { "title": "latitude", "description": "latitude", "type": "number", "format": "float", "example": 20.1005 }, "consignee_lon": { "title": "longitude", "description": "longitude", "type": "number", "format": "float", "example": 30.09925 }, "consignee_code_type": { "title": "Code type", "description": "Code type", "type": "string", "example": "national_address" }, "consignee_code_value": { "title": "Code Value", "description": "Code value", "type": "string", "example": "abc123" }, "consignee_address_label": { "title": "Consignee address label", "description": "Consignee address label (home or office)", "type": "string", "enum": [ "Home", "Office" ], "example": "Home" }, "consignee_building_number": { "title": "Consignee building number", "description": "Consignee building number", "type": "string", "maxLength": 4, "example": "12" }, "consignee_secondary_number": { "title": "Consignee secondary number", "description": "Consignee secondary number", "type": "string", "maxLength": 4, "example": "12" }, "consignee_delivery_instructions": { "title": "Consignee delivery instructions", "description": "Consignee delivery instructions", "type": "string", "example": "" }, "consignee_floor_number": { "title": "Consignee floor_number", "description": "Consignee floor_number", "type": "string", "example": "15" }, "consignee_street": { "title": "Consignee street", "description": "Consignee street", "type": "string", "example": "Baker" }, "consignee_landmark": { "title": "Consignee landmark", "description": "Consignee landmark", "type": "string", "maxLength": 100, "example": "Some landmark" }, "shipper_name": { "title": "Shipper name", "description": "Shipper name", "type": "string", "maxLength": 35, "example": "John Smith" }, "shipper_company": { "title": "Shipper company", "description": "Shipper company name", "type": "string", "maxLength": 35, "example": "" }, "shipper_address1": { "title": "Shipper address line 1", "description": "Shipper address line 1", "type": "string", "example": "Al Murabba" }, "shipper_address2": { "title": "Shipper address line 2", "description": "Shipper address line 2", "type": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd" }, "shipper_address3": { "title": "Shipper address line 3", "description": "Shipper address line 3. Rarely used", "type": "string", "example": "" }, "shipper_country": { "title": "Shipper country", "description": "Shipper country code (ISO 3166-1, Alpha-2 code):\n- For Domestic shipments can be SA only\n- For International shipments can be SA only\n * ", "type": "string", "maxLength": 2, "minLength": 2, "example": "SA" }, "shipper_city": { "title": "Shipper city", "description": "Shipper city", "type": "string", "example": "Riyadh" }, "shipper_state": { "title": "Shipper state", "description": "Shipper state", "type": "string", "maxLength": 100, "example": "Riyadh" }, "shipper_zip": { "title": "Shipper zip", "description": "Shipper zip", "type": "string", "maxLength": 35, "example": "" }, "shipper_phone": { "title": "Shipper phone", "description": "Shipper phone", "type": "string", "example": "+966 011 123 4566" }, "shipper_email": { "title": "Shipper email", "description": "Shipper email", "type": "string", "example": "John@mail.net" }, "shipper_vat": { "title": "Shipper VAT", "description": "Shipper VAT number", "type": "string", "example": "32197482341410" }, "shipper_lat": { "title": "latitude", "description": "latitude", "type": "number", "format": "float", "example": 20.1005 }, "shipper_lon": { "title": "longitude", "description": "longitude", "type": "number", "format": "float", "example": 30.09925 }, "shipper_code_type": { "title": "Code type", "description": "Code type", "type": "string", "example": "national_address" }, "shipper_code_value": { "title": "Code Value", "description": "Code value", "type": "string", "example": "abc123" }, "shipper_address_label": { "title": "Shipper address label", "description": "Shipper address label (home or office)", "type": "string", "enum": [ "Home", "Office" ], "example": "Home" }, "shipper_building_number": { "title": "Shipper building_number", "description": "Shipper building_number", "type": "string", "maxLength": 4, "example": "12" }, "shipper_secondary_number": { "title": "Shipper secondary number", "description": "Shipper secondary number", "type": "string", "maxLength": 4, "example": "12" }, "shipper_delivery_instructions": { "title": "Shipper delivery instructions", "description": "Shipper delivery instructions", "type": "string", "example": "" }, "shipper_floor_number": { "title": "Shipper floor_number", "description": "Shipper floor_number", "type": "string", "example": "15" }, "shipper_street": { "title": "Shipper street", "description": "Shipper street", "type": "string", "example": "Baker" }, "shipper_landmark": { "title": "Shipper landmark", "description": "Shipper landmark", "type": "string", "maxLength": 100, "example": "Some landmark" } }, "type": "object" }, "StoreShipmentRequest": { "title": "Store Shipment request", "description": "Store Shipment request body data", "required": [ "is_test", "api_key", "incoterm", "parcels", "service", "consignee_address", "shipper_address" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ShipmentBaseRequest" }, { "properties": { "collection_auto_confirm": { "title": "collection_auto_confirm", "description": "Ready for pickup", "type": "boolean", "example": true }, "parcels": { "title": "Parcels", "type": "array", "items": { "$ref": "#/components/schemas/ShipmentParcelItem" } } }, "type": "object" } ] }, "ParcelsListResponse": { "title": "Parcels list.", "properties": { "track_number": { "description": "Parcel`s tracking number.", "type": "string" }, "weight": { "description": "Parcel`s weight object.", "properties": { "value": { "description": "Parcel`s weight value.", "type": "number", "format": "float" }, "unit": { "description": "Weight measurement unit.", "type": "string" } }, "type": "object" }, "size": { "description": "Parcel`s size object.", "properties": { "width": { "description": "Parcel`s width.", "type": "number", "format": "float" }, "height": { "description": "Parcel`s height.", "type": "number", "format": "float" }, "length": { "description": "Parcel`s length.", "type": "number", "format": "float" } }, "type": "object" }, "confirmed": { "description": "Indicates that parcel`s confirmed.", "type": "integer" } }, "type": "object" }, "PudoPointResource": { "title": "Pudo point resource for courier", "properties": { "track_number": { "description": "Parcel`s tracking number.", "type": "string" }, "description": { "description": "Parcel`s description.", "type": "string" }, "weight": { "description": "Parcel`s weight object.", "properties": { "value": { "description": "Parcel`s weight value.", "type": "number", "format": "float" }, "unit": { "description": "Weight measurement unit.", "type": "string" } }, "type": "object" }, "size": { "description": "Parcel`s size object.", "properties": { "width": { "description": "Parcel`s width.", "type": "number", "format": "float" }, "height": { "description": "Parcel`s height.", "type": "number", "format": "float" }, "length": { "description": "Parcel`s length.", "type": "number", "format": "float" } }, "type": "object" }, "parcel_value": { "description": "Parcel`s price-currency information.", "properties": { "value": { "description": "Parcel`s price.", "type": "number", "format": "float" }, "currency": { "description": "Parcel`s price currency.", "type": "string" } }, "type": "object" }, "consignee_name": { "description": "Consignee name.", "type": "string" }, "consignee_phone": { "description": "Consignee phone number.", "type": "string" }, "consignee_comments": { "description": "Consignee comments.", "type": "string" }, "consignee_images": { "description": "Consignee images.", "type": "string" }, "consignee_address": { "description": "Consignee address for courier.", "type": "string" }, "consignee_location": { "description": "Consignee location.", "properties": { "lat": { "description": "Consignee location latitude.", "type": "number", "format": "float" }, "lon": { "description": "Consignee location longitude.", "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "ShipmentInfoResource": { "properties": { "address": { "properties": { "name": { "format": "string", "example": "John Smith" }, "company": { "format": "string", "example": "Google" }, "address1": { "format": "string", "example": "Al Murabba" }, "address2": { "format": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd" }, "address3": { "format": "string", "example": "" }, "city": { "format": "string", "example": "Riyadh" }, "state": { "format": "string", "example": "Riyadh" }, "zip": { "format": "string", "example": "11564" }, "country": { "format": "string", "example": "SA" }, "vat": { "format": "string", "example": "null" }, "geo": { "properties": { "lat": { "format": "string", "example": "50.0911" }, "lon": { "format": "string", "example": "50.0911" } }, "type": "object", "format": "object" } }, "type": "object", "format": "object" }, "shipper": { "properties": { "name": { "format": "string", "example": "Bill Dep" }, "company": { "format": "string", "example": "Track Inc." }, "address1": { "format": "string", "example": "Al Murabba" }, "address2": { "format": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd" }, "address3": { "format": "string", "example": "" }, "city": { "format": "string", "example": "LA" }, "state": { "format": "string", "example": "Riyadh" }, "zip": { "format": "string", "example": "11564" }, "country": { "format": "string", "example": "SA" }, "vat": { "format": "string", "example": "null" } }, "type": "object", "format": "object" } }, "type": "object" }, "ShipmentsListResponse": { "title": "Shipments list.", "properties": { "track_number": { "description": "Shipments`s tracking number.", "type": "string" }, "weight": { "description": "Shipment`s weight object.", "properties": { "value": { "description": "Shipment`s weight value.", "type": "number", "format": "float" }, "unit": { "description": "Weight measurement unit.", "type": "string" } }, "type": "object" }, "size": { "description": "Shipmen`s size object.", "properties": { "width": { "description": "Shipment`s width.", "type": "number", "format": "float" }, "height": { "description": "Shipment`s height.", "type": "number", "format": "float" }, "length": { "description": "Shipment`s length.", "type": "number", "format": "float" } }, "type": "object" }, "confirmed": { "description": "Indicates that shipment is confirmed.", "type": "integer" } }, "type": "object" }, "TaskShipmentListResource": { "title": "Task Shipemnts List.", "properties": { "track_number": { "description": "Shipments`s tracking number.", "type": "string" }, "description": { "description": "Shipments`s description.", "type": "string" }, "weight": { "description": "Shipments`s weight object.", "properties": { "value": { "description": "Shipements`s weight value.", "type": "number", "format": "float" }, "unit": { "description": "Weight measurement unit.", "type": "string" } }, "type": "object" }, "size": { "description": "Shipments`s size object.", "properties": { "width": { "description": "Shipments`s width.", "type": "number", "format": "float" }, "height": { "description": "Shipments`s height.", "type": "number", "format": "float" }, "length": { "description": "Shipments`s length.", "type": "number", "format": "float" } }, "type": "object" }, "shipment_value": { "description": "Shipments`s price-currency information.", "properties": { "value": { "description": "Shipments`s price.", "type": "number", "format": "float" }, "currency": { "description": "Shipments`s price currency.", "type": "string" } }, "type": "object" }, "consignee_name": { "description": "Consignee name.", "type": "string" }, "consignee_phone": { "description": "Consignee phone number.", "type": "string" }, "consignee_comments": { "description": "Consignee comments.", "type": "string" }, "consignee_images": { "description": "Consignee images.", "type": "string" }, "consignee_address": { "description": "Consignee address for courier.", "type": "string" }, "consignee_location": { "description": "Consignee location.", "properties": { "lat": { "description": "Consignee location latitude.", "type": "number", "format": "float" }, "lon": { "description": "Consignee location longitude.", "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "TasksListResponse": { "title": "Tasks list.", "properties": { "task_id": { "description": "Task identifier.", "type": "integer" }, "goal": { "description": "Task goal.", "type": "string", "enum": [ "delivery" ] }, "status": { "description": "Task status.", "type": "string", "enum": [ "in_progress", "success", "failed" ] }, "location": { "description": "Task location.", "type": "object" }, "driver_location": { "description": "Driver location.", "type": "object" }, "address": { "description": "Task address.", "type": "string" }, "driver_address": { "description": "Driver address.", "type": "string" }, "time_limit": { "description": "Time limit for the task.", "type": "string" }, "comments": { "description": "Comments to the task.", "type": "string" }, "driver_comments": { "description": "Driver comments to the task.", "type": "string" }, "images": { "description": "Images attached to the task.", "type": "object" }, "driver_images": { "description": "Driver images attached to the task.", "type": "object" }, "parcels": { "description": "Parcels attached to the task.", "type": "array", "items": { "$ref": "#/components/schemas/TaskShipmentListResource" } } }, "type": "object" }, "ImageInfoResponse": { "title": "Image details.", "properties": { "image_id": { "description": "Image internal identifier.", "type": "integer" }, "image_key": { "description": "Unique image identifier. Can be used to build an url for downloading images.", "type": "string" }, "name": { "description": "Image name.", "type": "string" }, "tags": { "description": "Tags assigned to the image.", "type": "string" }, "size": { "description": "Image size in bytes.", "type": "integer" }, "width": { "description": "Image width.", "type": "integer" }, "height": { "description": "Image height.", "type": "integer" }, "MIME-type": { "description": "Image MIME-type", "type": "string", "enum": [ "image/png", "image/jpg" ] }, "comments": { "description": "Comments assigned to the image.", "type": "string" } }, "type": "object" }, "ParcelInfoResource": { "properties": { "status": { "format": "string", "example": "Delivered" }, "date_start": { "format": "string", "example": "2022-07-14T17:02:03.000000Z" }, "description": { "format": "string", "example": "description" }, "current_location": { "format": "string", "example": "SA, Kiev, 02121, Kreshatic 3, 330" }, "weight": { "properties": { "value": { "format": "integer", "example": "1" }, "unit": { "format": "string", "example": "kg" } }, "type": "object", "format": "object" }, "dimensions": { "properties": { "width": { "format": "string", "example": "10" }, "height": { "format": "string", "example": "20" }, "length": { "format": "string", "example": "20" } }, "type": "object", "format": "object" }, "parcel_value": { "properties": { "value": { "format": "string", "example": "10" }, "currency": { "format": "string", "example": "USD" } }, "type": "object", "format": "object" }, "cod": { "properties": { "value": { "format": "string", "example": "10" }, "currency": { "format": "string", "example": "USD" } }, "type": "object", "format": "object" }, "address": { "properties": { "name": { "format": "string", "example": "John Smith" }, "company": { "format": "string", "example": "Google" }, "address1": { "format": "string", "example": "Al Murabba" }, "address2": { "format": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd" }, "address3": { "format": "string", "example": "" }, "city": { "format": "string", "example": "Riyadh" }, "state": { "format": "string", "example": "Riyadh" }, "zip": { "format": "string", "example": "11564" }, "country": { "format": "string", "example": "SA" }, "vat": { "format": "string", "example": "null" }, "geo": { "properties": { "lat": { "format": "string", "example": "50.0911" }, "lon": { "format": "string", "example": "50.0911" } }, "type": "object", "format": "object" } }, "type": "object", "format": "object" }, "shipper": { "properties": { "name": { "format": "string", "example": "Bill Dep" }, "company": { "format": "string", "example": "Track Inc." }, "address1": { "format": "string", "example": "Al Murabba" }, "address2": { "format": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd" }, "address3": { "format": "string", "example": "" }, "city": { "format": "string", "example": "LA" }, "state": { "format": "string", "example": "Riyadh" }, "zip": { "format": "string", "example": "11564" }, "country": { "format": "string", "example": "SA" }, "vat": { "format": "string", "example": "null" } }, "type": "object", "format": "object" }, "history": { "type": "array", "items": { "properties": { "date": { "type": "string", "example": "2022-07-14T17:02:03.000000Z" }, "location": { "properties": { "city": { "type": "string", "example": "NY" }, "country": { "type": "string", "example": "USA" } }, "type": "object" }, "activity": { "type": "string", "example": "event description" } }, "type": "object" } } }, "type": "object" }, "ParcelResourceResponse": { "properties": { "id": { "type": "integer", "example": "10" }, "track_number": { "type": "string", "example": "000000000012637" }, "status": { "type": "string", "example": "Created" }, "current_location": { "type": "string", "example": "GB, London, London, GB, Great Russel 13A" }, "date_start": { "type": "string", "example": "2021-11-30 10:50:12" }, "description": { "type": "string", "example": "some text" }, "direction": { "type": "string", "example": "to_user" }, "address": { "properties": { "name": { "type": "string", "example": "John Smith" }, "company": { "type": "string", "example": "Starlinks" }, "address1": { "type": "string", "example": "AD DUBIYAH" }, "address2": { "type": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd, Level 1" }, "address3": { "type": "string", "example": "Al Murabba" }, "city": { "type": "string", "example": "Riyadh" }, "state": { "type": "string", "example": "Riyadh" }, "zip": { "type": "string", "example": "11564" }, "country": { "type": "string", "example": "Riyadh" }, "vat": { "type": "string", "example": "1234" }, "geo": { "properties": { "lat": { "type": "string", "example": "40.011" }, "lon": { "type": "string", "example": "50.011" } }, "type": "object" } }, "type": "object" }, "shipper": { "properties": { "name": { "type": "string", "example": "Jane Smith" }, "company": { "type": "string", "example": "Clothing retailer ltd." }, "address1": { "type": "string", "example": "Great Russel st. 5" }, "address2": { "type": "string", "example": "12A" }, "address3": { "type": "string", "example": "B2" }, "city": { "type": "string", "example": "London" }, "state": { "type": "string", "example": "London" }, "zip": { "type": "string", "example": "WC1B 3DG" }, "country": { "type": "string", "example": "GB" }, "vat": { "type": "string", "example": "1234" } }, "type": "object" } }, "type": "object" }, "PaymentResource": { "properties": { "payment_status": { "type": "string", "example": "Completed" }, "payment_link_id": { "type": "string", "example": "e0ee031232b0ec93f7d46280a860e9eb" }, "payment_link_url": { "type": "string", "example": "https://some.com" }, "transaction_id": { "type": "string", "example": "8acb6e7ea647918ac76ab3da7b1a688f" }, "transaction_ref_num": { "type": "string", "example": "12345" }, "payment_mode": { "type": "string", "example": "Cash" }, "card_type": { "type": "string", "example": "Visa" }, "amount": { "type": "number", "format": "float", "example": 99.99 }, "completed_at": { "type": "string", "example": "2026-02-16T13:50:53+00:00" } }, "type": "object" }, "AddressCode": { "title": "Address code", "description": "Address code attributes", "properties": { "type": { "title": "Type", "description": "Code type", "type": "string", "enum": [ "w3w", "national_address" ], "example": "national_address" }, "value": { "title": "Value", "description": "Code value", "type": "string", "example": "abc123" } }, "type": "object" }, "AddressExtra": { "title": "Address extra fields", "description": "Address extra fields. Used for specific carriers/cases", "properties": { "extra_field_1": { "title": "Extra field 1", "description": "Extra field 1", "type": "string", "example": "Yellow flower shop" }, "extra_field_2": { "title": "Extra field 2", "description": "Extra field 2", "type": "string", "example": "" }, "extra_field_3": { "title": "Extra field 3", "description": "Extra field 3", "type": "string", "example": "" } }, "type": "object" }, "ConsigneeAddress": { "title": "Consignee address", "description": "Consignee address", "required": [ "name", "phone", "address1", "city", "country" ], "properties": { "name": { "title": "Consignee name", "description": "Consignee name", "type": "string", "maxLength": 35, "example": "John Smith" }, "company": { "title": "Consignee company", "description": "Consignee company name", "type": "string", "maxLength": 35, "example": "" }, "address1": { "title": "Consignee address line 1", "description": "Consignee address line 1", "type": "string", "example": "Al Murabba" }, "address2": { "title": "Consignee address line 2", "description": "Consignee address line 2", "type": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd" }, "address3": { "title": "Consignee address line 3", "description": "Consignee address line 3. Rarely used", "type": "string", "example": "" }, "city": { "title": "Consignee city", "description": "Consignee city", "type": "string", "example": "Riyadh" }, "state": { "title": "Consignee state", "description": "Consignee state", "type": "string", "maxLength": 100, "example": "Riyadh" }, "zip": { "title": "Consignee zip", "description": "Consignee zip", "type": "string", "maxLength": 35, "example": "" }, "country": { "title": "Consignee country", "description": "Consignee country code (ISO 3166-1, Alpha-2 code):\n- For Domestic shipments can be SA only\n- For International shipments can be SA only\n * ", "type": "string", "maxLength": 2, "minLength": 2, "example": "SA" }, "phone": { "title": "Consignee phone", "description": "Consignee phone", "type": "string", "example": "+966 011 123 4566" }, "email": { "title": "Consignee email", "description": "Consignee email", "type": "string", "example": "John@mail.net" }, "vat": { "title": "Consignee VAT", "description": "Consignee VAT number", "type": "string", "example": "32197482341410" }, "id_number": { "title": "Consignee ID number", "description": "Consignee ID number", "type": "string", "example": "RT123456789GH" }, "customs_data": { "$ref": "#/components/schemas/CustomsData" }, "address_extra": { "$ref": "#/components/schemas/AddressExtra" }, "address_code": { "$ref": "#/components/schemas/AddressCode" }, "geo": { "$ref": "#/components/schemas/Geo" }, "address_label": { "title": "Consignee address label", "description": "Consignee address label (home or office)", "type": "string", "enum": [ "Home", "Office" ], "example": "Home" }, "building_number": { "title": "Consignee building_number", "description": "Consignee building_number", "type": "string", "maxLength": 4, "example": "12" }, "secondary_number": { "title": "Consignee secondary number", "description": "Consignee secondary number", "type": "string", "maxLength": 4, "example": "12" }, "delivery_instructions": { "title": "Consignee delivery instructions", "description": "Consignee delivery instructions", "type": "string", "example": "" }, "floor_number": { "title": "Consignee floor_number", "description": "Consignee floor_number", "type": "string", "example": "15" }, "street": { "title": "Consignee street", "description": "Consignee street", "type": "string", "example": "Baker" }, "landmark": { "title": "Consignee landmark", "description": "Consignee landmark", "type": "string", "maxLength": 100, "example": "Some landmark" } }, "type": "object" }, "CustomsData": { "title": "Customs data", "description": "Data for customs clearance, tax and duties calculation", "properties": { "eori_number": { "title": "EORI Number", "description": "EORI Number", "type": "string", "example": "GB123456" }, "ioss_number": { "title": "OISS Number", "description": "IOSS Number", "type": "string", "example": "GB123456" } }, "type": "object" }, "Event": { "title": "Event", "description": "Parcel history event", "properties": { "event_code": { "title": "Event code", "description": "System code of event", "type": "integer", "example": 300 }, "event_name": { "title": "Event name", "description": "Name of event", "type": "string", "example": "Created" }, "carrier_event_code": { "title": "Event code", "description": "Code returned by carrier", "type": "string", "example": "A200" }, "event_date": { "title": "Event date", "description": "Date of event", "type": "string", "example": "2020-10-01 08:13:59" }, "event_description": { "title": "Description", "description": "Description of event", "type": "string", "example": "Created" }, "event_country": { "title": "Country", "description": "Country of event", "type": "string", "example": "US" }, "event_state": { "title": "State", "description": "State of event", "type": "string" }, "event_city": { "title": "City", "description": "City of event", "type": "string", "example": "New York" }, "event_zip": { "title": "ZIP", "description": "ZIP of event", "type": "string", "example": "85001" }, "event_address_line1": { "title": "Address Line 1", "description": "Address Line 1 of event", "type": "string" }, "event_address_line2": { "title": "Address Line 2", "description": "Address Line 2 of event", "type": "string" }, "event_address_line3": { "title": "Address Line 3", "description": "Address Line 3 of event", "type": "string" }, "event_additional": { "title": "Additional", "description": "Additional info", "type": "object" } }, "type": "object" }, "Geo": { "title": "Geo", "description": "Geo coordinates", "properties": { "latitude": { "title": "latitude", "description": "latitude", "type": "number", "format": "float", "example": 20.1005 }, "longitude": { "title": "longitude", "description": "longitude", "type": "number", "format": "float", "example": 30.09925 } }, "type": "object" }, "PUDOAddress": { "title": "Address", "description": "Address", "required": [ "country", "state", "city", "zip", "address1", "lat", "lon" ], "properties": { "country": { "title": "Country", "description": "Country code (ISO 3166-1, Alpha-2 code)", "type": "string", "maxLength": 2, "minLength": 2, "example": "SA" }, "state": { "title": "State", "description": "State", "type": "string", "example": "Riyadh" }, "city": { "title": "City", "description": "City", "type": "string", "example": "Riyadh" }, "zip": { "title": "ZIP", "description": "ZIP / Postal code", "type": "string", "maxLength": 10, "minLength": 1, "example": "" }, "phone": { "title": "Phone", "description": "Phone", "type": "string", "example": "508052961" }, "address1": { "title": "Address line 1", "description": "Address line 1", "type": "string", "example": "Al Murabba" }, "address2": { "title": "Address line 2", "description": "Address line 2", "type": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd, Riyadh Avenue Mall, Level 1" }, "address3": { "title": "Address line 3", "description": "Address line 3. Rarely used", "type": "string", "example": "" }, "address_extra": { "$ref": "#/components/schemas/AddressExtra" } }, "type": "object" }, "Package": { "title": "Package data", "description": "Package data including it's size, weight, value", "required": [ "incoterm" ], "properties": { "number_of_pieces": { "title": "Number of pieces", "description": "Always 1", "type": "integer", "format": "integer", "example": "1" }, "order_reference": { "title": "Order reference", "description": "Order reference. This can be your order number or ID", "type": "string", "format": "string", "minLength": 3, "example": "A9900001" }, "customer_id_reference": { "title": "Customer Id Reference", "description": "Unique reference provided by the customer.", "type": "string", "format": "string", "example": "TEZQFUZJFI" }, "track_number": { "title": "Tracking number", "description": "Tracking number generated and provided by the customer.", "type": "string", "format": "string", "example": "QQ0000001SF" }, "invoice": { "title": "Invoice number", "description": "Invoice number", "type": "string", "format": "string", "example": "AB12221241" }, "description": { "title": "Parcel description", "description": "Description of the parcel contents", "type": "string", "format": "string", "maxLength": 100, "example": "Black leather jacket" }, "rgr_number": { "title": "RGR number", "description": "\nReturned Goods Relief number.\nSubject to specific conditions, Returned Goods Relief (RGR) removes or reduces\nthe repayment of import duties for goods that are re-imported into the same\ncustoms territory that they have already been exported from.\n * ", "type": "string", "format": "string", "example": "QS12344411DN" }, "export_entry_number": { "title": "Export entry number", "description": "\n Customs export entry number.\n ", "type": "string", "format": "string", "example": "QS12344411DN" }, "incoterm": { "title": "Incoterm", "description": "International Commercial Term.", "type": "string", "format": "string", "enum": [ "DDU", "DDP" ], "example": "DDU" }, "value": { "title": "Parcel value", "description": "Total parcel value", "type": "number", "format": "double", "example": "29.99" }, "currency": { "title": "Parcel currency", "description": "Currency", "type": "string", "format": "string", "example": "SAR" }, "cod_value": { "title": "COD value", "description": "The amount to pay for Cash on delivery", "type": "number", "format": "double", "example": "29.99" }, "cod_currency": { "title": "COD currency", "description": "Cash on delivery currency", "type": "string", "format": "string", "example": "SAR" }, "weight": { "title": "Parcel weight (KG)", "description": "Parcel weight in kilograms", "type": "number", "format": "double", "example": "5.85" }, "category": { "title": "Parcel category", "description": "Parcel category", "type": "string", "enum": [ "commercial_goods", "gifts", "documents", "commercial_sample", "returned_goods", "other", "clothing", "intercompany_transfer", "repair", "personal_items" ], "example": "commercial_goods" }, "length": { "title": "Parcel length (cm)", "description": "Parcel length in centimeters", "type": "number", "format": "double", "example": "50.1" }, "width": { "title": "Parcel width (cm)", "description": "Parcel width in centimeters", "type": "number", "format": "double", "example": "40.1" }, "height": { "title": "Parcel height (cm)", "description": "Parcel height in centimeters", "type": "number", "format": "double", "example": "10" }, "is_dangerous": { "title": "Dangerous Goods", "description": "Partcel with dangerous goods", "type": "boolean", "example": "1" } }, "type": "object" }, "PackageExtra": { "title": "Package extra fields", "description": "Package extra fields. Used for specific carriers/cases", "properties": { "extra_field_1": { "title": "Extra field 1", "description": "Extra field 1", "type": "string", "example": "Yellow box with flowers" }, "extra_field_2": { "title": "Extra field 2", "description": "Extra field 2", "type": "string", "example": "" }, "extra_field_3": { "title": "Extra field 3", "description": "Extra field 3", "type": "string", "example": "" } }, "type": "object" }, "PackageHistory": { "title": "PackageHistory", "description": "Parcel item request body data", "properties": { "carrier_event_code": { "title": "carrier_event_code", "description": "carrier_event_code", "type": "string", "example": "" }, "event_date": { "title": "event_date", "description": "event_date", "type": "string", "example": "2021-11-29T20:24:50.000000Z" }, "event_description": { "title": "event_description", "description": "event_description", "type": "string", "example": "Parcel created by Jane Smith" }, "event_country": { "title": "event_country", "type": "string", "example": "GB" }, "event_state": { "title": "event_state", "type": "string", "example": "London" }, "event_city": { "title": "event_city", "type": "string", "example": "London" }, "event_zip": { "title": "event_zip", "type": "string", "example": "12345" }, "event_address_line1": { "title": "event_address_line1", "type": "string", "example": "Great Russel st. 5" }, "event_address_line2": { "title": "event_address_line2", "type": "string", "example": "12A" }, "event_address_line3": { "title": "event_address_line3", "type": "string", "example": "B2" }, "event_additional": { "title": "event_additional", "type": "string", "example": "{}" }, "event_code": { "title": "event_code", "type": "integer", "example": "100" } }, "type": "object" }, "ParcelGroupData": { "title": "Parcel Group container info", "description": "Parcel Group container info", "required": [ "carrier", "label_format", "parcels", "type" ], "properties": { "type": { "title": "Parcel Group container type", "description": "Parcel Group container type. Can be one of the following:\n1. Bag. The smallest entity. Can only include parcels\n2. Pallet. Can include parcels, bags, pallets\n3. Shipment. Can include parcels, bags, pallets. Shipments usually represent trucks, planes\n * ", "type": "string", "format": "string", "example": "Pallet" }, "carrier": { "title": "Parcel group carrier", "description": "Parcel group carrier. Available carriers: IPC", "type": "string", "format": "string", "example": "IPC" }, "label_format": { "title": "Label format", "description": "Format of the shipping label. One of the following: PDF, ZPL200, ZPL300", "type": "string", "format": "string", "example": "ZPL300" }, "title": { "title": "Group title", "description": "Group title", "type": "string", "format": "string", "example": "Group #11" }, "parcels": { "title": "A list of consolidated parcels", "description": "A list of consolidated parcels", "type": "array", "items": { "$ref": "#/components/schemas/ParcelGroupItem" } } }, "type": "object" }, "ParcelGroupItem": { "title": "Parcel Group container info", "description": "Parcel Group container info", "required": [ "tracking_number" ], "properties": { "tracking_number": { "title": "An existing parcel's tracking number", "description": "An existing parcel's tracking number", "type": "string", "format": "string", "example": "S0000001000" } }, "type": "object" }, "ParcelItem": { "title": "Parcel item", "description": "Parcel item request body data", "required": [ "quantity", "description", "value", "currency" ], "properties": { "sku": { "title": "SKU", "description": "SKU code", "type": "string", "example": "AB0001" }, "description": { "title": "Item description", "description": "Item description", "type": "string", "example": "White T-shirt" }, "value": { "title": "Item value", "description": "Value of a single unit with a currency used from the parcel's data", "type": "number", "format": "double", "example": "9.99" }, "total_value": { "title": "Item total value", "description": "Total value of a single unit with a currency used from the parcel's data", "type": "number", "format": "double", "example": "19.99" }, "currency": { "title": "currency", "type": "string", "example": "SAR" }, "quantity": { "title": "Item quantity", "description": "How many items shipped", "type": "integer", "example": "3" }, "country_of_origin": { "title": "Country of origin", "description": "Country of origin, item manufacturer. Country code (ISO 3166-1, Alpha-2 code)", "type": "string", "example": "CN" }, "hs_code": { "title": "HS code", "description": "Harmonized System code", "type": "string", "example": "51051000" }, "image_url": { "title": "Image URL", "description": "Image URL", "type": "string", "example": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/2f/Google_2015_logo.svg/1024px-Google_2015_logo.svg.png" }, "parcel_item_extra": { "$ref": "#/components/schemas/ParcelItemExtra" } }, "type": "object" }, "ParcelItemExtra": { "title": "Parcel item extra fields", "description": "Parcel item extra fields. Used for specific carriers/cases", "properties": { "extra_field_1": { "title": "Extra field 1", "description": "Extra field 1", "type": "string", "example": "Yellow flower" }, "extra_field_2": { "title": "Extra field 2", "description": "Extra field 2", "type": "string", "example": "" }, "extra_field_3": { "title": "Extra field 3", "description": "Extra field 3", "type": "string", "example": "" } }, "type": "object" }, "SearchPUDOAddress": { "title": "Address", "description": "Address", "properties": { "country": { "title": "Country", "description": "Country code (ISO 3166-1, Alpha-2 code)", "type": "string", "maxLength": 2, "minLength": 2, "example": "SA" }, "state": { "title": "State", "description": "State", "type": "string", "example": "Riyadh" }, "city": { "title": "City", "description": "City", "type": "string", "example": "Riyadh" }, "suburb": { "title": "Suburb", "description": "Suburban area", "type": "string", "example": "" }, "zip": { "title": "ZIP", "description": "ZIP / Postal code", "type": "string", "maxLength": 10, "minLength": 1, "example": "" }, "address1": { "title": "Address line 1", "description": "Address line 1", "type": "string", "example": "Al Murabba" }, "address2": { "title": "Address line 2", "description": "Address line 2", "type": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd, Riyadh Avenue Mall, Level 1" }, "address3": { "title": "Address line 3", "description": "Address line 3. Rarely used", "type": "string", "example": "" }, "phone": { "title": "Phone", "description": "Phone", "type": "string", "example": "+44 7911 123456" }, "lat": { "title": "Latitude", "description": "Latitude", "type": "number", "format": "float", "maximum": 90, "minimum": -90 }, "lon": { "title": "Longitude", "description": "Longitude", "type": "number", "format": "float", "maximum": 180, "minimum": -180 } }, "type": "object" }, "Service": { "title": "Shipping Service data", "description": "Shipping service data, including service code and shipping label format", "required": [ "service_code" ], "properties": { "service_code": { "title": "Service code", "description": "Shipping service code", "type": "string", "format": "string", "example": "SA_INT" }, "label_format": { "title": "Label format", "description": "Format of the shipping label. One of the following: PDF, PDF4x6, ZPL200, ZPL300, PNG", "type": "string", "format": "string", "enum": [ "PDF", "PDF4x6", "ZPL200", "ZPL300", "PNG" ], "example": "ZPL300" }, "display_id": { "title": "Display ID", "description": "Additional text on the label. Applicable only for specific services", "type": "string", "format": "string", "example": "my_internal_id" }, "pudo_id": { "title": "PUDO ID", "description": "ID of the pick-up drop-off point", "type": "string", "format": "string", "example": "A100" } }, "type": "object" }, "ShipmentHistory": { "title": "Shipment History", "description": "Shipment`s history events", "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PackageHistory" }, "x-additionalPropertiesName": "tracking_number" } }, "ShipmentParcelItem": { "title": "Parcel in shipment", "description": "Parcel in shipment", "required": [ "products" ], "properties": { "weight": { "title": "Parcel weight (KG)", "description": "Parcel weight in kilograms", "type": "number", "format": "double", "example": "5.85" }, "value": { "title": "Parcel value", "description": "Total parcel value", "type": "number", "format": "double", "example": "29.99" }, "currency": { "title": "Parcel currency", "description": "Currency", "type": "string", "format": "string", "example": "SAR" }, "length": { "title": "Parcel length (cm)", "description": "Parcel length in centimeters", "type": "number", "format": "double", "example": "50.1" }, "width": { "title": "Parcel width (cm)", "description": "Parcel width in centimeters", "type": "number", "format": "double", "example": "40.1" }, "height": { "title": "Parcel height (cm)", "description": "Parcel height in centimeters", "type": "number", "format": "double", "example": "10" }, "description": { "title": "Parcel description", "description": "Description", "type": "string", "example": "Black leather jacket" }, "products": { "title": "Products", "type": "array", "items": { "$ref": "#/components/schemas/ShipmentParcelProductItem" } } }, "type": "object" }, "ShipmentParcelProductItem": { "title": "Products in Parcel in Shipment", "description": "Products in Parcel in Shipment", "required": [ "description", "quantity", "value" ], "properties": { "sku": { "title": "SKU", "description": "SKU code", "type": "string", "example": "AB0001" }, "description": { "title": "Item description", "description": "Item description", "type": "string", "example": "White T-shirt" }, "value": { "title": "Item value", "description": "Value of a single unit with a currency used from the parcel's data", "type": "number", "format": "double", "example": "9.99" }, "currency": { "title": "currency", "type": "string", "example": "SAR" }, "quantity": { "title": "Item quantity", "description": "How many items shipped", "type": "integer", "example": "3" }, "country_of_origin": { "title": "Country of origin", "description": "Country of origin, item manufacturer. Country code (ISO 3166-1, Alpha-2 code)", "type": "string", "example": "CN" }, "hs_code": { "title": "HS code", "description": "Harmonized System code", "type": "string", "example": "51051000" }, "image_url": { "title": "Image URL", "description": "Image URL", "type": "string", "example": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/2f/Google_2015_logo.svg/1024px-Google_2015_logo.svg.png" }, "parcel_item_extra": { "$ref": "#/components/schemas/ParcelItemExtra" } }, "type": "object" }, "ShipmentRecreateParcelItem": { "title": "Parcel in shipment", "description": "Parcel in shipment", "required": [ "products", "track_number" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ShipmentParcelItem" }, { "properties": { "customer_id_reference": { "title": "Customer Id Reference", "description": "Unique reference provided by the customer.", "type": "string", "format": "string", "example": "TEZQFUZJFI" }, "track_number": { "title": "Tracking number", "description": "Tracking number generated and provided by the customer.", "type": "string", "format": "string", "example": "QQ0000001SF" } }, "type": "object" } ] }, "ShipmentService": { "title": "Shipping Service data", "description": "Shipping service data, including service code and shipping label format", "required": [ "service_code" ], "properties": { "service_code": { "title": "Service code", "description": "Shipping service code", "type": "string", "format": "string", "example": "SA_INT" }, "label_format": { "description": "Label format. Pass multiple to receive labels in multiple formats.", "oneOf": [ { "title": "Single label format", "description": "Single label format, as string", "type": "string", "format": "string", "enum": [ "PDF4x6", "PDF", "ZPL200", "ZPL300", "PNG" ], "example": "PDF4x6" }, { "title": "Multiple label formats", "type": "array", "items": { "description": "Multiple label formats, as list of strings", "type": "string", "format": "string", "enum": [ "PDF4X6", "PDF", "ZPL200", "ZPL300", "PNG" ], "example": "PDF4X6" } } ] }, "display_id": { "title": "Display ID", "description": "Additional text on the label. Applicable only for specific services", "type": "string", "format": "string", "example": "my_internal_id" }, "pudo_id": { "title": "PUDO ID", "description": "ID of the pick-up drop-off point", "type": "string", "format": "string", "example": "A100" } }, "type": "object" }, "ShipperAddress": { "title": "Shipper address", "description": "Shipper address", "required": [ "name", "address1", "city", "country", "phone" ], "properties": { "name": { "title": "Shipper name", "description": "Shipper name", "type": "string", "maxLength": 35, "example": "Jane Smith" }, "company": { "title": "Shipper company", "description": "Shipper company name", "type": "string", "maxLength": 35, "example": "Clothing retailer ltd." }, "address1": { "title": "Shipper address line 1", "description": "Shipper address line 1", "type": "string", "example": "Great Russel st. 5" }, "address2": { "title": "Shipper address line 2", "description": "Shipper address line 2", "type": "string", "example": "12A" }, "address3": { "title": "Shipper address line 3", "description": "Shipper address line 3. Rarely used", "type": "string", "example": "B2" }, "city": { "title": "Shipper city", "description": "Shipper city", "type": "string", "maxLength": 35, "example": "London" }, "state": { "title": "Shipper state", "description": "Shipper state", "type": "string", "maxLength": 100, "example": "London" }, "zip": { "title": "Shipper zip", "description": "Shipper zip", "type": "string", "maxLength": 35, "example": "WC1B 3DG" }, "country": { "title": "Shipper country", "description": "Shipper country code (ISO 3166-1, Alpha-2 code):\n- For Domestic shipments can be SA only\n- For International shipments can be anything but SA\n * ", "type": "string", "maxLength": 2, "minLength": 2, "example": "GB" }, "phone": { "title": "Shipper phone", "description": "Shipper phone", "type": "string", "example": "+44 7911 123456" }, "email": { "title": "Shipper email", "description": "Shipper email", "type": "string", "example": "Jane@clothesltd.com" }, "vat": { "title": "Shipper VAT", "description": "Shipper VAT number", "type": "string", "example": "32197482341410" }, "customs_data": { "$ref": "#/components/schemas/CustomsData" }, "address_extra": { "$ref": "#/components/schemas/AddressExtra" }, "address_code": { "$ref": "#/components/schemas/AddressCode" }, "geo": { "$ref": "#/components/schemas/Geo" }, "pudo_id": { "title": "Shipper PUDO", "description": "Shipper PUDO id", "type": "string", "example": "A100" }, "address_label": { "title": "Shipper address label", "description": "Shipper address label (home or office)", "type": "string", "enum": [ "Home", "Office" ], "example": "Home" }, "building_number": { "title": "Shipper building_number", "description": "Shipper building_number", "type": "string", "maxLength": 4, "example": "12" }, "secondary_number": { "title": "Shipper secondary number", "description": "Shipper secondary number", "type": "string", "maxLength": 4, "example": "12" }, "delivery_instructions": { "title": "Shipper delivery instructions", "description": "Shipper delivery instructions", "type": "string", "example": "" }, "floor_number": { "title": "Shipper floor_number", "description": "Shipper floor_number", "type": "string", "example": "15" }, "street": { "title": "Shipper street", "description": "Shipper street", "type": "string", "example": "Baker" }, "landmark": { "title": "Shipper landmark", "description": "Shipper landmark", "type": "string", "maxLength": 100, "example": "Some landmark" } }, "type": "object" }, "ParcelItemsResource": { "properties": { "sku": { "type": "string", "example": "AB0001" }, "description": { "type": "string", "example": "White T-shirt" }, "price": { "type": "number", "format": "float", "example": "9.99" }, "total_value": { "type": "number", "format": "float", "example": "29.97" }, "currency": { "type": "string", "example": "SAR" }, "quantity": { "type": "number", "format": "float", "example": "3" }, "country_of_origin": { "type": "string", "example": "CN" }, "hs_code": { "type": "string", "example": "51051000" }, "image_url": { "type": "string", "example": "https://upload.wikimedia.org/logo.svg.png" } }, "type": "object" }, "ShipmentParcelResourceResponse": { "properties": { "track_number": { "type": "string", "example": "000000000012637" }, "description": { "type": "string", "example": "some text" }, "warehouse_id": { "type": "integer", "example": "10" }, "label": { "type": "string", "example": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/KQovQ3JlYXRvciAo/v8AdwBrAGgAdABtAGwAdABvAHAAZABmACAAMAAuADEAMgAuADEALgA0KQovUHJvZHVjZXIgKP7/AFEAdAAgADQALgA4AC4ANikKL0NyZWF..." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ParcelItemsResource" } } }, "type": "object" }, "ParcelStoreMultiLabelResourceResponse": { "properties": { "track_number": { "type": "string", "example": "S0000000123.001" }, "customs_broker_tracking_number": { "type": "string", "example": "123456789" }, "labels": { "type": "array", "items": { "properties": { "format": { "type": "string", "enum": [ "PDF4x6", "PDF", "ZPL300", "ZPL200", "PNG" ], "example": "PDF4x6" }, "content": { "type": "string", "example": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/KQovQ3JlYXRvciAo/v8AdwBrAGgAdABtAGwAdABvAHAAZABmACAAMAAuADEAMgAuADEALgA0KQovUHJvZHVjZXIgKP7/AFEAdAAgADQALgA4AC4ANikKL0NyZWF..." } }, "type": "object" } } }, "type": "object" }, "ParcelStoreResourceResponse": { "properties": { "track_number": { "type": "string", "example": "000000000012637" }, "customs_broker_tracking_number": { "type": "string", "example": "1312311123" }, "label": { "type": "string", "example": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/KQovQ3JlYXRvciAo/v8AdwBrAGgAdABtAGwAdABvAHAAZABmACAAMAAuADEAMgAuADEALgA0KQovUHJvZHVjZXIgKP7/AFEAdAAgADQALgA4AC4ANikKL0NyZWF..." } }, "type": "object" }, "ShipmentResource": { "properties": { "status": { "type": "string", "example": "Created" }, "latest_tracking_event": { "properties": { "event_code": { "type": "integer", "example": 105 }, "event_name": { "type": "string", "example": "Pickup Attempted" }, "carrier_event_code": { "type": "string", "example": "A200" }, "event_date": { "type": "string", "example": "2020-10-01 08:13:59" }, "event_description": { "type": "string", "example": "Pickup Attempted" }, "event_country": { "type": "string", "example": "SA" }, "event_state": { "type": "string", "example": "Riyadh" }, "event_city": { "type": "string", "example": "Riyadh" }, "event_zip": { "type": "string", "example": "12211" }, "event_address_line1": { "type": "string", "example": "AD DUBIYAH" }, "event_address_line2": { "type": "string", "example": "Prince Faisal Bin Turki Abdul Rd, Level 1" }, "event_address_line3": { "type": "string", "example": "Al Murabba" } }, "type": "object" }, "is_test": { "type": "string", "example": "true" }, "track_number": { "type": "string", "example": "TSTS0000000000" }, "customer_name": { "type": "string", "example": "test_name" }, "external_tracking_number": { "type": "string", "example": "TSTS0000000000" }, "service_code": { "type": "string", "example": "SA_INT" }, "number_of_pieces": { "type": "integer", "example": "1" }, "order_reference": { "type": "string", "example": "A99000012" }, "customer_id_reference": { "type": "string", "example": "2341235" }, "invoice": { "type": "string", "example": "AB12221241" }, "duty_invoice_url": { "type": "string", "example": "https://..." }, "description": { "type": "string", "example": "Black leather jacket" }, "rgr_number": { "type": "string", "example": "QS12344411DN" }, "export_entry_number": { "type": "string", "example": "QS12344411DN" }, "incoterm": { "type": "string", "example": "DDU" }, "price": { "type": "number", "format": "float", "example": 10.1 }, "currency": { "type": "string", "example": "SAR" }, "cod_value": { "type": "number", "format": "float", "example": 29.99 }, "cod_currency": { "type": "string", "example": "SAR" }, "is_dangerous": { "type": "boolean", "example": true }, "category": { "type": "string", "example": "commercial_goods" }, "label_format": { "type": "string", "example": "ZPL300" }, "display_id": { "type": "string", "example": "my_internal_id" }, "pudo_id": { "type": "string", "example": "A100" }, "scheduled_delivery_date": { "type": "string", "example": "2025-01-01" }, "chargeable_weight": { "description": "Chargeable weight, in kgs", "type": "number", "format": "float", "example": 3.12 }, "volumetric_weight": { "description": "Volumetric weight, in kgs", "type": "number", "format": "float", "example": 3.12 }, "actual_weight": { "description": "Actual weight, in kgs", "type": "number", "format": "float", "example": 3.12 }, "consignee": { "properties": { "name": { "type": "string", "example": "John Smith" }, "company": { "type": "string", "example": "Starlinks" }, "address1": { "type": "string", "example": "AD DUBIYAH" }, "address2": { "type": "string", "example": "Prince Faisal Bin Turki Bin Abdul Aziz Rd, Level 1" }, "address3": { "type": "string", "example": "Al Murabba" }, "city": { "type": "string", "example": "Riyadh" }, "state": { "type": "string", "example": "Riyadh" }, "zip": { "type": "string", "example": "11564" }, "country": { "type": "string", "example": "SA" }, "phone": { "type": "string", "example": "32197482341410" }, "email": { "type": "string", "example": "kolya.cheran@xmlshop.com" }, "id_number": { "type": "string", "example": "RT123456789GH" }, "address_id": { "type": "string", "example": null }, "delivery_zone": { "type": "string", "example": "RGG4" }, "vat": { "type": "string", "example": "32197482341410" }, "eori_number": { "type": "string", "example": "GB123456" }, "ioss_number": { "type": "string", "example": "GB123456" }, "code_type": { "type": "string", "example": "national_address" }, "code_value": { "type": "string", "example": "abc123" }, "address_extra": { "properties": { "extra_field_1": { "type": "string", "example": "Yellow flower shop" }, "extra_field_2": { "type": "string", "example": "null" }, "extra_field_3": { "type": "string", "example": "null" } }, "type": "object" }, "geo": { "properties": { "latitude": { "type": "number", "format": "float", "example": 20.1005 }, "longitude": { "type": "number", "format": "float", "example": 30.09925 } }, "type": "object" }, "address_label": { "type": "string", "example": "Home" }, "building_number": { "type": "string", "example": "12" }, "secondary_number": { "type": "string", "example": "12" }, "delivery_instructions": { "type": "string", "example": "abc123" }, "floor_number": { "type": "string", "example": "5" }, "street": { "type": "string", "example": "abc1234" }, "landmark": { "type": "string", "example": "abc12345" } }, "type": "object" }, "shipper": { "properties": { "name": { "type": "string", "example": "Jane Smith" }, "company": { "type": "string", "example": "Clothing retailer ltd." }, "address1": { "type": "string", "example": "Great Russel st. 5" }, "address2": { "type": "string", "example": "12A" }, "address3": { "type": "string", "example": "B2" }, "city": { "type": "string", "example": "London" }, "state": { "type": "string", "example": "London" }, "zip": { "type": "string", "example": "WC1B 3DG" }, "country": { "type": "string", "example": "GB" }, "phone": { "type": "string", "example": "32197482341410" }, "email": { "type": "string", "example": "kolya.cheran@xmlshop.com" }, "id_number": { "type": "string", "example": "RT123456789GH" }, "vat": { "type": "string", "example": "32197482341410" }, "eori_number": { "type": "string", "example": "GB123456" }, "ioss_number": { "type": "string", "example": "GB123456" }, "code_type": { "type": "string", "example": "national_address" }, "code_value": { "type": "string", "example": "abc123" }, "address_extra": { "properties": { "extra_field_1": { "type": "string", "example": "Yellow flower shop" }, "extra_field_2": { "type": "string", "example": "null" }, "extra_field_3": { "type": "string", "example": "null" } }, "type": "object" }, "geo": { "properties": { "latitude": { "type": "number", "format": "float", "example": 20.1005 }, "longitude": { "type": "number", "format": "float", "example": 30.09925 } }, "type": "object" }, "address_label": { "type": "string", "example": "Home" }, "building_number": { "type": "string", "example": "12" }, "secondary_number": { "type": "string", "example": "12" }, "delivery_instructions": { "type": "string", "example": "abc123" }, "floor_number": { "type": "string", "example": "5" }, "street": { "type": "string", "example": "abc1234" }, "landmark": { "type": "string", "example": "abc12345" } }, "type": "object" }, "label": { "type": "string", "example": "XlhBCgpeTEwxMj ..." }, "parcels": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentParcelResourceResponse" } } }, "type": "object" }, "ShipmentStoreMultiLabelResource": { "required": [ "track_number", "customs_broker_tracking_number", "labels", "parcels" ], "properties": { "track_number": { "type": "string", "example": "TSTS0000000000" }, "customs_broker_tracking_number": { "type": "string", "example": "2341235" }, "labels": { "type": "array", "items": { "required": [ "format", "content" ], "properties": { "format": { "type": "string", "enum": [ "PDF4X6", "PDF", "ZPL300", "ZPL200", "PNG" ], "example": "PDF4X6" }, "content": { "type": "string", "example": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/KQovQ3JlYXRvciAo/v8AdwBrAGgAdABtAGwAdABvAHAAZABmACAAMAAuADEAMgAuADEALgA0KQovUHJvZHVjZXIgKP7/AFEAdAAgADQALgA4AC4ANikKL0NyZWF..." }, "URI": { "description": "URI to download the shipment label.\nOnly present when `include.labelURI` request parameter is on.", "type": "string", "example": "https://starlinksapi.app/api/v1/shipments/S123123/public-label?format=PDF4x6&signature=bff14..." } }, "type": "object" } }, "parcels": { "type": "array", "items": { "$ref": "#/components/schemas/ParcelStoreMultiLabelResourceResponse" } } }, "type": "object" }, "ShipmentStoreResource": { "required": [ "track_number", "customs_broker_tracking_number", "label", "parcels" ], "properties": { "track_number": { "type": "string", "example": "TSTS0000000000" }, "customs_broker_tracking_number": { "type": "string", "example": "2341235" }, "label": { "type": "string", "example": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/KQovQ3JlYXRvciAo/v8AdwBrAGgAdABtAGwAdABvAHAAZABmACAAMAAuADEAMgAuADEALgA0KQovUHJvZHVjZXIgKP7/AFEAdAAgADQALgA4AC4ANikKL0NyZWF..." }, "labelURI": { "description": "URI to download the shipment label. Only present when `include.labelURI` request parameter is on.", "type": "string", "example": "https://starlinksapi.app/api/v1/shipments/S123123/public-label?format=PDF4x6&signature=bff14..." }, "parcels": { "type": "array", "items": { "$ref": "#/components/schemas/ParcelStoreResourceResponse" } } }, "type": "object" } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "api-key", "in": "header" } } }, "tags": [ { "name": "Shipments", "description": "Shipments" }, { "name": "ParcelGroups", "description": "ParcelGroups" }, { "name": "Parcels", "description": "Parcels" }, { "name": "Pudo", "description": "Pudo" } ] }