{ "openapi": "3.1.0", "info": { "title": "ShipBG API", "version": "v1", "description": "ShipBG multi-carrier shipping aggregation API. Integer monetary request fields use ISO 4217 minor units (for example, 100.01 BGN is 10001). See https:\/\/github.com\/SK-Software-Ltd\/shipbg for source." }, "servers": [ { "url": "https:\/\/backend-martin.tunnel.shipbg.com\/api\/v1", "description": "Local (backend-martin.tunnel.shipbg.com)" }, { "url": "https:\/\/shipbg.com\/api\/v1", "description": "Production" }, { "url": "https:\/\/staging.shipbg.com\/api\/v1", "description": "Staging" } ], "paths": { "\/account": { "get": { "operationId": "v1.account.show", "tags": [ "Account" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "name" ] }, "domain": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "tier": { "type": "string" }, "is_active": { "type": "boolean" } }, "required": [ "id", "name", "tier", "is_active" ] }, "subscription": { "type": [ "object", "null" ], "properties": { "status": { "type": "string" }, "tier": { "type": "string" }, "current_period_end": { "type": "string" }, "manage_url": { "type": "string" } }, "required": [ "status", "tier", "current_period_end", "manage_url" ] }, "usage": { "type": "object", "properties": { "monthly_api_requests": { "type": "integer" }, "monthly_shipments": { "type": "integer" }, "shipment_limit": { "type": "integer" }, "paid_domains_count": { "type": "integer" }, "free_domains_count": { "type": "integer" } }, "required": [ "monthly_api_requests", "monthly_shipments", "shipment_limit", "paid_domains_count", "free_domains_count" ] } }, "required": [ "user", "domain", "subscription", "usage" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/account\/email\/request-change": { "post": { "operationId": "v1.account.email.request-change", "tags": [ "Account" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "new_email": { "type": "string", "format": "email", "maxLength": 255 } }, "required": [ "new_email" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "new_email": { "type": "string" }, "expires_at": { "type": "string" } }, "required": [ "new_email", "expires_at" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/account\/email\/confirm-change": { "post": { "operationId": "v1.account.email.confirm-change", "tags": [ "Account" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 10 } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" } }, "required": [ "email" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/account\/profile": { "patch": { "operationId": "v1.account.profile.update", "tags": [ "Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "maxLength": 255 } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/addresses:normalize": { "post": { "operationId": "v1.addresses.normalize", "tags": [ "AddressNormalize" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NormalizeAddressCommand" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "normalized": { "type": "string" }, "address": { "type": "string" }, "confidence": { "type": "string" }, "provider": { "type": "string" } }, "required": [ "normalized", "address", "confidence", "provider" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/auth\/tokens": { "post": { "operationId": "v1.auth.tokens.store", "tags": [ "AuthTokens" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 }, "password": { "type": "string", "maxLength": 255 }, "device_name": { "type": "string", "maxLength": 255 }, "domain_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "email", "password", "device_name" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_id": { "type": "string" }, "device_name": { "type": "string" }, "domain_id": { "type": [ "string", "null" ] } }, "required": [ "access_token", "token_id", "device_name", "domain_id" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/auth\/tokens\/exchange": { "post": { "operationId": "v1.auth.tokens.exchange", "tags": [ "AuthTokens" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "exchange_token": { "type": "string", "maxLength": 255 }, "device_name": { "type": "string", "maxLength": 255 } }, "required": [ "exchange_token", "device_name" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_id": {}, "device_name": { "type": "string" }, "domain_id": { "type": "string" } }, "required": [ "access_token", "token_id", "device_name", "domain_id" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/auth\/tokens\/{token}": { "delete": { "operationId": "v1.auth.tokens.destroy", "tags": [ "AuthTokens" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/geocode\/autocomplete": { "get": { "operationId": "v1.geocode.autocomplete", "tags": [ "AutocompleteAddress" ], "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 255 } }, { "name": "country", "in": "query", "schema": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 20 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" }, "address": { "type": "string" }, "provider": { "type": "string" }, "confidence": { "type": "string" } }, "required": [ "latitude", "longitude", "address", "provider", "confidence" ] } } }, "required": [ "suggestions" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments:bulk-generate-labels": { "post": { "operationId": "v1.shipments.bulk-generate-labels", "tags": [ "BulkBatches" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "paper_size": { "type": [ "string", "null" ], "enum": [ "A4", "A6" ] }, "shipment_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1 } }, "required": [ "shipment_ids" ] } } } }, "responses": { "202": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "total": { "type": "integer" }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" }, "progress": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "shipment_ids": { "type": "array", "items": {} }, "results": { "type": "array", "items": {} }, "merged_label_url": { "type": [ "string", "null" ] }, "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "type", "status", "total", "succeeded", "failed", "progress", "shipment_ids", "results", "merged_label_url", "started_at", "completed_at", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments:bulk-cancel": { "post": { "operationId": "v1.shipments.bulk-cancel", "tags": [ "BulkBatches" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "shipment_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1 } }, "required": [ "shipment_ids" ] } } } }, "responses": { "202": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "total": { "type": "integer" }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" }, "progress": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "shipment_ids": { "type": "array", "items": {} }, "results": { "type": "array", "items": {} }, "merged_label_url": { "type": [ "string", "null" ] }, "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "type", "status", "total", "succeeded", "failed", "progress", "shipment_ids", "results", "merged_label_url", "started_at", "completed_at", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/bulk-batches\/{bulkBatch}": { "get": { "operationId": "v1.bulk-batches.show", "tags": [ "BulkBatches" ], "parameters": [ { "name": "bulkBatch", "in": "path", "required": true, "description": "The bulk batch ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "total": { "type": "integer" }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" }, "progress": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "shipment_ids": { "type": "array", "items": {} }, "results": { "type": "array", "items": {} }, "merged_label_url": { "type": [ "string", "null" ] }, "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "type", "status", "total", "succeeded", "failed", "progress", "shipment_ids", "results", "merged_label_url", "started_at", "completed_at", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/bulk-batches\/{bulkBatch}\/labels": { "get": { "operationId": "v1.bulk-batches.labels", "tags": [ "BulkBatches" ], "parameters": [ { "name": "bulkBatch", "in": "path", "required": true, "description": "The bulk batch ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/pdf": { "schema": { "type": "string" } } }, "headers": { "Content-Disposition": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "string" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carrier-accounts\/defaults": { "get": { "operationId": "v1.carrier-accounts.defaults", "tags": [ "CarrierAccounts" ], "parameters": [ { "name": "environment", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carrier-accounts\/test": { "post": { "operationId": "v1.carrier-accounts.test", "tags": [ "CarrierAccounts" ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TestCarrierConnectionCommand" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean" }, "carrier": { "type": "string" }, "message": { "type": "string" } }, "required": [ "success", "carrier", "message" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "carrier": { "type": "string" }, "message": { "type": [ "string", "null" ], "const": "Carrier rejected the credentials." } }, "required": [ "success", "carrier", "message" ] }, { "type": "object", "properties": { "success": { "type": "boolean" }, "carrier": { "type": "null" }, "message": { "type": "string" } }, "required": [ "success", "carrier", "message" ] } ] } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carrier-accounts\/{courierAccount}\/discovery": { "get": { "operationId": "v1.carrier-accounts.discovery", "tags": [ "CarrierAccounts" ], "parameters": [ { "name": "courierAccount", "in": "path", "required": true, "description": "The courier account ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carrier-accounts\/{courierAccount}\/capabilities": { "get": { "operationId": "v1.carrier-accounts.capabilities", "tags": [ "CarrierAccounts" ], "parameters": [ { "name": "courierAccount", "in": "path", "required": true, "description": "The courier account ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "carrier": { "type": "string" }, "contracts": { "type": "array", "items": {} }, "services": { "type": "array", "items": {} }, "agreements": { "type": "array", "items": {} }, "lockers": { "type": "array", "items": {} } }, "required": [ "carrier", "contracts", "services", "agreements", "lockers" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carrier-accounts": { "get": { "operationId": "v1.carrier-accounts.index", "tags": [ "CarrierAccounts" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.carrier-accounts.store", "tags": [ "CarrierAccounts" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateCarrierAccountCommand" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "carrier": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "is_active": { "type": "boolean" }, "is_test": { "type": "boolean" }, "has_credentials": { "type": "boolean" }, "sender_config": { "type": "string" }, "settings": { "anyOf": [ { "type": "array", "items": {} }, { "type": "null" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "carrier", "name", "is_active", "is_test", "has_credentials", "sender_config", "settings", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carrier-accounts\/{courierAccount}": { "get": { "operationId": "v1.carrier-accounts.show", "tags": [ "CarrierAccounts" ], "parameters": [ { "name": "courierAccount", "in": "path", "required": true, "description": "The courier account ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "carrier": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "is_active": { "type": "boolean" }, "is_test": { "type": "boolean" }, "has_credentials": { "type": "boolean" }, "sender_config": { "type": "string" }, "settings": { "anyOf": [ { "type": "array", "items": {} }, { "type": "null" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "carrier", "name", "is_active", "is_test", "has_credentials", "sender_config", "settings", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "v1.carrier-accounts.update", "tags": [ "CarrierAccounts" ], "parameters": [ { "name": "courierAccount", "in": "path", "required": true, "description": "The courier account ID", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateCarrierAccountCommand" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "carrier": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "is_active": { "type": "boolean" }, "is_test": { "type": "boolean" }, "has_credentials": { "type": "boolean" }, "sender_config": { "type": "string" }, "settings": { "anyOf": [ { "type": "array", "items": {} }, { "type": "null" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "carrier", "name", "is_active", "is_test", "has_credentials", "sender_config", "settings", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "v1.carrier-accounts.destroy", "tags": [ "CarrierAccounts" ], "parameters": [ { "name": "courierAccount", "in": "path", "required": true, "description": "The courier account ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carrier-routing": { "get": { "operationId": "v1.carrier-routing.show", "tags": [ "CarrierRouting" ], "parameters": [ { "name": "domain_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} }, "warnings": { "type": "array", "items": {} } }, "required": [ "data", "warnings" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "v1.carrier-routing.update", "tags": [ "CarrierRouting" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateCarrierRoutingCommand" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} }, "warnings": { "type": "array", "items": {} } }, "required": [ "data", "warnings" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carriers\/verification-destinations": { "get": { "operationId": "v1.carriers.verification-destinations.index", "tags": [ "CarrierVerificationDestinations" ], "parameters": [ { "name": "carriers", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carriers": { "get": { "operationId": "v1.carriers.index", "tags": [ "Carriers" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/checkout\/options": { "post": { "operationId": "v1.checkout.options", "tags": [ "Checkout" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BuildCheckoutOptionsCommand" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string" }, "home_min": { "type": [ "array", "null" ], "items": {} }, "pickup_min": { "type": [ "array", "null" ], "items": {} }, "customer_coordinates": { "type": [ "array", "null" ], "items": {} }, "carrier_icons": { "type": "array", "items": {} }, "home_options": { "type": "array", "items": {} }, "pickup_options": { "type": "array", "items": {} }, "errors": { "type": "array", "items": {} } }, "required": [ "currency", "home_min", "pickup_min", "customer_coordinates", "carrier_icons", "home_options", "pickup_options", "errors" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carriers\/econt\/address:validate": { "post": { "operationId": "v1.carriers.econt.address-validate", "tags": [ "EcontAddressValidate" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "city": { "type": "string", "default": "" }, "postcode": { "type": "string", "default": "" }, "country": { "type": "string", "default": "BG" }, "address_line1": { "type": "string", "default": "" }, "address_line2": { "type": "string", "default": "" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } }, "500": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Econt adapter does not support address validation." } }, "required": [ "message" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "No active Econt account." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/carriers\/econt\/nomenclature": { "get": { "operationId": "v1.carriers.econt.nomenclature", "tags": [ "EcontNomenclature" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "city_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "items": { "type": [ "string", "null" ] } }, "required": [ "items" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Invalid type or missing city_id." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "No active Econt account." } }, "required": [ "message" ] } ] } } } }, "500": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Econt adapter does not support nomenclature." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/geocode": { "post": { "operationId": "v1.geocode", "tags": [ "Geocode" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeocodeAddressCommand" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "provider": { "type": "string" }, "confidence": { "type": [ "number", "null" ] }, "cache_hit": { "type": "boolean" }, "address": { "type": [ "string", "null" ] } }, "required": [ "latitude", "longitude", "provider", "confidence", "cache_hit", "address" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/health": { "get": { "operationId": "v1.health", "tags": [ "Health" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/hs-codes": { "get": { "operationId": "v1.hs-codes.index", "tags": [ "HsCodes" ], "parameters": [ { "name": "version", "in": "query", "schema": { "type": "string" } }, { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" } }, { "name": "leaf_only", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} }, "meta": { "type": "object", "properties": { "total": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": [ "total", "limit", "offset" ] } }, "required": [ "data", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/onboarding\/concierge": { "get": { "operationId": "v1.onboarding.concierge.show", "tags": [ "OnboardingConcierge" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "pending": { "type": "boolean" }, "status": { "type": "string" }, "requested_at": { "type": "string" } }, "required": [ "pending", "status", "requested_at" ] }, { "type": "object", "properties": { "pending": { "type": "boolean" }, "status": { "type": "null" }, "requested_at": { "type": "null" } }, "required": [ "pending", "status", "requested_at" ] } ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.onboarding.concierge.store", "tags": [ "OnboardingConcierge" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "wizard", "settings" ] }, "contact_email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "contact_phone": { "type": [ "string", "null" ], "maxLength": 64 }, "message": { "type": [ "string", "null" ], "maxLength": 2000 }, "selected_carriers": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 64 } } }, "required": [ "source" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "pending": { "type": "boolean" }, "status": { "type": "string" }, "requested_at": { "type": "string" } }, "required": [ "pending", "status", "requested_at" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "A connected store is required before concierge onboarding can be requested." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pickup-points": { "get": { "operationId": "v1.pickup-points.index", "tags": [ "PickupPoints" ], "parameters": [ { "name": "city", "in": "query", "schema": { "type": "string" } }, { "name": "radius_km", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "carrier", "in": "query", "schema": { "type": "string" } }, { "name": "carrier_point_id", "in": "query", "schema": { "type": "string" } }, { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "country_code", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string", "default": 50 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "carrier": { "type": "string" }, "carrier_point_id": { "type": "string" }, "code": {}, "name": { "type": "object", "properties": { "bg": { "type": "string" }, "en": { "type": [ "string", "null" ] } }, "required": [ "bg", "en" ] }, "type": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "postal_code": { "type": "string" }, "coordinates": { "type": [ "object", "null" ], "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "required": [ "latitude", "longitude" ] }, "is_active": { "type": "boolean" } }, "required": [ "id", "carrier", "carrier_point_id", "code", "name", "type", "address", "city", "postal_code", "coordinates", "is_active" ] } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": [ "total", "limit", "offset" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "data", "meta", "reason" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pickup-points\/providers": { "get": { "operationId": "v1.pickup-points.providers", "tags": [ "PickupPoints" ], "parameters": [ { "name": "country_code", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pickup-points\/{pickupPoint}": { "get": { "operationId": "v1.pickup-points.show", "tags": [ "PickupPoints" ], "parameters": [ { "name": "pickupPoint", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "carrier": { "type": "string" }, "carrier_point_id": { "type": "string" }, "code": {}, "name": { "type": "object", "properties": { "bg": { "type": "string" }, "en": { "type": [ "string", "null" ] } }, "required": [ "bg", "en" ] }, "type": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "postal_code": { "type": "string" }, "coordinates": { "type": [ "object", "null" ], "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "required": [ "latitude", "longitude" ] }, "is_active": { "type": "boolean" } }, "required": [ "id", "carrier", "carrier_point_id", "code", "name", "type", "address", "city", "postal_code", "coordinates", "is_active" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pickups": { "post": { "operationId": "v1.pickups.store", "tags": [ "Pickups" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "carrier": { "type": "string" }, "carrier_account_id": { "type": "string", "format": "uuid" }, "pickup_date": { "type": "string", "format": "date" }, "address": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "note": { "type": [ "string", "null" ], "maxLength": 500 }, "shipment_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1 }, "time_window": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "contact": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "name", "phone" ] } }, "required": [ "carrier", "carrier_account_id", "pickup_date", "address", "shipment_ids", "time_window", "contact" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "carrier": { "type": "string" }, "carrier_pickup_id": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "pickup_date": { "type": "string" }, "time_window": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "shipment_count": { "type": "integer" }, "shipment_ids": { "type": "array", "items": {} }, "address": { "type": "array", "items": {} }, "contact": { "type": "array", "items": {} }, "note": { "type": [ "string", "null" ] }, "confirmation": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "carrier", "carrier_pickup_id", "status", "pickup_date", "time_window", "shipment_count", "shipment_ids", "address", "contact", "note", "confirmation", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pickups\/{pickup}": { "get": { "operationId": "v1.pickups.show", "tags": [ "Pickups" ], "parameters": [ { "name": "pickup", "in": "path", "required": true, "description": "The pickup ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "carrier": { "type": "string" }, "carrier_pickup_id": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "pickup_date": { "type": "string" }, "time_window": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "shipment_count": { "type": "integer" }, "shipment_ids": { "type": "array", "items": {} }, "address": { "type": "array", "items": {} }, "contact": { "type": "array", "items": {} }, "note": { "type": [ "string", "null" ] }, "confirmation": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "carrier", "carrier_pickup_id", "status", "pickup_date", "time_window", "shipment_count", "shipment_ids", "address", "contact", "note", "confirmation", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/plans": { "get": { "operationId": "v1.plans", "tags": [ "Plans" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } } } } }, "\/pricing-rule-templates": { "get": { "operationId": "v1.pricing-rule-templates.index", "tags": [ "PricingRuleTemplates" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "required_any_carrier": { "type": "array", "items": {} }, "suggested_priority": { "type": "integer" }, "stop_on_match": { "type": "boolean" }, "conditions": { "type": "array", "items": {} }, "actions": { "type": "array", "items": {} } }, "required": [ "id", "name", "description", "category", "required_any_carrier", "suggested_priority", "stop_on_match", "conditions", "actions" ] } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pricing-rules": { "get": { "operationId": "v1.pricing-rules.index", "tags": [ "PricingRules" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": {} } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.pricing-rules.store", "tags": [ "PricingRules" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "enabled": { "type": "boolean" }, "priority": { "type": "integer", "minimum": 0, "maximum": 65535 }, "stop_on_match": { "type": "boolean" }, "domain_id": { "type": [ "string", "null" ], "format": "uuid" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "order_total", "order_weight", "product_category", "product_shipping_class", "carrier", "delivery_type" ] }, "operator": { "type": "string", "enum": [ "=", "!=", ">", ">=", "<", "<=", "in", "not_in", "contains" ] }, "value": { "type": "string" } }, "required": [ "field", "operator", "value" ] } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "free_shipping", "flat_rate", "percentage_discount", "fixed_discount", "merchant_subsidy" ] }, "value": { "type": [ "integer", "null" ], "minimum": 0 }, "unit": { "type": [ "string", "null" ], "enum": [ "fixed", "percent" ] } }, "required": [ "type" ] }, "minItems": 1, "maxItems": 1 } }, "required": [ "name", "conditions", "actions" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "priority": { "type": "integer" }, "stop_on_match": { "type": "boolean" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": [ "string", "null" ] }, "operator": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "field", "operator", "value" ] } }, "actions": { "type": "array", "prefixItems": [ { "type": "object", "additionalProperties": {} } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "enabled", "priority", "stop_on_match", "conditions", "actions", "created_at", "updated_at" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pricing-rules:reorder": { "post": { "operationId": "v1.pricing-rules.reorder", "tags": [ "PricingRules" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1 } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": {} } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/pricing-rules\/{pricingRule}": { "get": { "operationId": "v1.pricing-rules.show", "tags": [ "PricingRules" ], "parameters": [ { "name": "pricingRule", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "priority": { "type": "integer" }, "stop_on_match": { "type": "boolean" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": [ "string", "null" ] }, "operator": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "field", "operator", "value" ] } }, "actions": { "type": "array", "prefixItems": [ { "type": "object", "additionalProperties": {} } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "enabled", "priority", "stop_on_match", "conditions", "actions", "created_at", "updated_at" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "v1.pricing-rules.update", "tags": [ "PricingRules" ], "parameters": [ { "name": "pricingRule", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "enabled": { "type": "boolean" }, "priority": { "type": "integer", "minimum": 0, "maximum": 65535 }, "stop_on_match": { "type": "boolean" }, "domain_id": { "type": [ "string", "null" ], "format": "uuid" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "order_total", "order_weight", "product_category", "product_shipping_class", "carrier", "delivery_type" ] }, "operator": { "type": "string", "enum": [ "=", "!=", ">", ">=", "<", "<=", "in", "not_in", "contains" ] }, "value": { "type": "string" } }, "required": [ "field", "operator", "value" ] } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "free_shipping", "flat_rate", "percentage_discount", "fixed_discount", "merchant_subsidy" ] }, "value": { "type": [ "integer", "null" ], "minimum": 0 }, "unit": { "type": [ "string", "null" ], "enum": [ "fixed", "percent" ] } }, "required": [ "type" ] }, "minItems": 1, "maxItems": 1 } }, "required": [ "name", "conditions", "actions" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "priority": { "type": "integer" }, "stop_on_match": { "type": "boolean" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": [ "string", "null" ] }, "operator": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "field", "operator", "value" ] } }, "actions": { "type": "array", "prefixItems": [ { "type": "object", "additionalProperties": {} } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "enabled", "priority", "stop_on_match", "conditions", "actions", "created_at", "updated_at" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "v1.pricing-rules.destroy", "tags": [ "PricingRules" ], "parameters": [ { "name": "pricingRule", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/rates:quote": { "post": { "operationId": "v1.rates.quote", "tags": [ "Rates" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/QuoteRatesCommand" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "rates": { "type": "array", "items": {} }, "errors": { "type": "array", "items": {} }, "currency": { "type": "string" } }, "required": [ "rates", "errors", "currency" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments\/{shipment}\/returns": { "post": { "operationId": "v1.shipments.returns.store", "tags": [ "Returns" ], "parameters": [ { "name": "shipment", "in": "path", "required": true, "description": "The shipment ID", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "maxLength": 500 }, "notes": { "type": [ "string", "null" ], "maxLength": 1000 }, "pickup_type": { "type": [ "string", "null" ], "enum": [ "address", "office", "locker" ] }, "from_address": { "type": [ "array", "null" ], "items": { "type": "string" } }, "to_address": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "reason" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "original_shipment_id": { "type": "string" }, "carrier": { "type": "string" }, "status": { "type": "string" }, "replaced_status": { "type": "string" }, "return_type": { "type": [ "string", "null" ] }, "pickup_type": { "type": [ "string", "null" ] }, "tracking_code": { "type": [ "string", "null" ] }, "carrier_shipment_id": { "type": [ "string", "null" ] }, "service_code": { "type": [ "string", "null" ] }, "return_reason": { "type": "string" }, "notes": { "type": [ "string", "null" ] }, "label_url": { "type": [ "string", "null" ] }, "from_address": { "type": "string" }, "to_address": { "type": "string" }, "parcel": { "type": "string" }, "order_ref": { "type": [ "string", "null" ] }, "rate": { "type": [ "object", "null" ], "properties": { "amount": { "type": "integer" }, "currency": { "type": [ "string", "null" ] } }, "required": [ "amount", "currency" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "original_shipment_id", "carrier", "status", "replaced_status", "return_type", "pickup_type", "tracking_code", "carrier_shipment_id", "service_code", "return_reason", "notes", "label_url", "from_address", "to_address", "parcel", "order_ref", "rate", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "get": { "operationId": "v1.shipments.returns.index", "tags": [ "Returns" ], "parameters": [ { "name": "shipment", "in": "path", "required": true, "description": "The shipment ID", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "carrier", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} }, "meta": { "type": "object", "properties": { "cursor": { "type": "string" }, "has_more": { "type": "boolean" }, "count": { "type": "integer" } }, "required": [ "cursor", "has_more", "count" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/returns": { "get": { "operationId": "v1.returns.index", "tags": [ "Returns" ], "parameters": [ { "name": "original_shipment_id", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "carrier", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} }, "meta": { "type": "object", "properties": { "cursor": { "type": "string" }, "has_more": { "type": "boolean" }, "count": { "type": "integer" } }, "required": [ "cursor", "has_more", "count" ] } }, "required": [ "data", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/returns\/{returnShipment}": { "get": { "operationId": "v1.returns.show", "tags": [ "Returns" ], "parameters": [ { "name": "returnShipment", "in": "path", "required": true, "description": "The return shipment ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "original_shipment_id": { "type": "string" }, "carrier": { "type": "string" }, "status": { "type": "string" }, "replaced_status": { "type": "string" }, "return_type": { "type": [ "string", "null" ] }, "pickup_type": { "type": [ "string", "null" ] }, "tracking_code": { "type": [ "string", "null" ] }, "carrier_shipment_id": { "type": [ "string", "null" ] }, "service_code": { "type": [ "string", "null" ] }, "return_reason": { "type": "string" }, "notes": { "type": [ "string", "null" ] }, "label_url": { "type": [ "string", "null" ] }, "from_address": { "type": "string" }, "to_address": { "type": "string" }, "parcel": { "type": "string" }, "order_ref": { "type": [ "string", "null" ] }, "rate": { "type": [ "object", "null" ], "properties": { "amount": { "type": "integer" }, "currency": { "type": [ "string", "null" ] } }, "required": [ "amount", "currency" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "original_shipment_id", "carrier", "status", "replaced_status", "return_type", "pickup_type", "tracking_code", "carrier_shipment_id", "service_code", "return_reason", "notes", "label_url", "from_address", "to_address", "parcel", "order_ref", "rate", "created_at", "updated_at" ] } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/returns\/{returnShipment}\/label": { "get": { "operationId": "v1.returns.label", "tags": [ "Returns" ], "parameters": [ { "name": "returnShipment", "in": "path", "required": true, "description": "The return shipment ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/pdf": { "schema": { "type": "string" } } }, "headers": { "Content-Disposition": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "string" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments": { "get": { "operationId": "v1.shipments.index", "tags": [ "Shipments" ], "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "carrier", "in": "query", "schema": { "type": "string" } }, { "name": "tracking_code", "in": "query", "schema": { "type": "string" } }, { "name": "order_ref", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} }, "meta": { "type": "object", "properties": { "cursor": { "type": "string" }, "has_more": { "type": "boolean" }, "count": { "type": "integer" } }, "required": [ "cursor", "has_more", "count" ] } }, "required": [ "data", "meta" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.shipments.store", "tags": [ "Shipments" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateShipmentCommand" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": {}, "carrier": { "type": "string" }, "status": { "type": "string" }, "tracking_code": { "type": [ "string", "null" ] }, "carrier_shipment_id": { "type": [ "string", "null" ] }, "service_code": { "type": [ "string", "null" ] }, "service_name": { "type": "string" }, "order_ref": { "type": [ "string", "null" ] }, "pickup_point_id": { "type": "null" }, "sender": { "type": "string" }, "recipient": { "type": "string" }, "parcel": { "type": "string" }, "options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "carrier_options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rate": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": [ "string", "null" ] } }, "required": [ "amount", "currency" ] }, "estimated_days": { "type": "string" }, "label_url": { "type": [ "string", "null" ] }, "label_format": { "type": "null" }, "selected_rate": { "type": [ "object", "null" ], "properties": { "id": {}, "carrier": { "type": "string" }, "service_code": { "type": "string" }, "service_label": { "type": [ "string", "null" ] }, "amount": { "type": "integer" }, "currency": { "type": "string" }, "delivery_type": { "type": [ "string", "null" ] }, "estimated_delivery_days": { "type": [ "integer", "null" ] }, "is_selected": { "type": "boolean" } }, "required": [ "id", "carrier", "service_code", "service_label", "amount", "currency", "delivery_type", "estimated_delivery_days", "is_selected" ] }, "carrier_capabilities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "rates": { "type": "string" }, "tracking_events": { "type": "string" } }, "required": [ "id", "carrier", "status", "tracking_code", "carrier_shipment_id", "service_code", "service_name", "order_ref", "pickup_point_id", "sender", "recipient", "parcel", "options", "carrier_options", "rate", "estimated_days", "label_url", "label_format", "selected_rate", "carrier_capabilities", "created_at", "updated_at", "rates", "tracking_events" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments\/{shipment}": { "get": { "operationId": "v1.shipments.show", "tags": [ "Shipments" ], "parameters": [ { "name": "shipment", "in": "path", "required": true, "description": "The shipment ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": {}, "carrier": { "type": "string" }, "status": { "type": "string" }, "tracking_code": { "type": [ "string", "null" ] }, "carrier_shipment_id": { "type": [ "string", "null" ] }, "service_code": { "type": [ "string", "null" ] }, "service_name": { "type": "string" }, "order_ref": { "type": [ "string", "null" ] }, "pickup_point_id": { "type": "null" }, "sender": { "type": "string" }, "recipient": { "type": "string" }, "parcel": { "type": "string" }, "options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "carrier_options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rate": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": [ "string", "null" ] } }, "required": [ "amount", "currency" ] }, "estimated_days": { "type": "string" }, "label_url": { "type": [ "string", "null" ] }, "label_format": { "type": "null" }, "selected_rate": { "type": [ "object", "null" ], "properties": { "id": {}, "carrier": { "type": "string" }, "service_code": { "type": "string" }, "service_label": { "type": [ "string", "null" ] }, "amount": { "type": "integer" }, "currency": { "type": "string" }, "delivery_type": { "type": [ "string", "null" ] }, "estimated_delivery_days": { "type": [ "integer", "null" ] }, "is_selected": { "type": "boolean" } }, "required": [ "id", "carrier", "service_code", "service_label", "amount", "currency", "delivery_type", "estimated_delivery_days", "is_selected" ] }, "carrier_capabilities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "rates": { "type": "string" }, "tracking_events": { "type": "string" } }, "required": [ "id", "carrier", "status", "tracking_code", "carrier_shipment_id", "service_code", "service_name", "order_ref", "pickup_point_id", "sender", "recipient", "parcel", "options", "carrier_options", "rate", "estimated_days", "label_url", "label_format", "selected_rate", "carrier_capabilities", "created_at", "updated_at", "rates", "tracking_events" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "patch": { "operationId": "v1.shipments.update", "tags": [ "Shipments" ], "parameters": [ { "name": "shipment", "in": "path", "required": true, "description": "The shipment ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": {}, "carrier": { "type": "string" }, "status": { "type": "string" }, "tracking_code": { "type": [ "string", "null" ] }, "carrier_shipment_id": { "type": [ "string", "null" ] }, "service_code": { "type": [ "string", "null" ] }, "service_name": { "type": "string" }, "order_ref": { "type": [ "string", "null" ] }, "pickup_point_id": { "type": "null" }, "sender": { "type": "string" }, "recipient": { "type": "string" }, "parcel": { "type": "string" }, "options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "carrier_options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rate": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": [ "string", "null" ] } }, "required": [ "amount", "currency" ] }, "estimated_days": { "type": "string" }, "label_url": { "type": [ "string", "null" ] }, "label_format": { "type": "null" }, "selected_rate": { "type": [ "object", "null" ], "properties": { "id": {}, "carrier": { "type": "string" }, "service_code": { "type": "string" }, "service_label": { "type": [ "string", "null" ] }, "amount": { "type": "integer" }, "currency": { "type": "string" }, "delivery_type": { "type": [ "string", "null" ] }, "estimated_delivery_days": { "type": [ "integer", "null" ] }, "is_selected": { "type": "boolean" } }, "required": [ "id", "carrier", "service_code", "service_label", "amount", "currency", "delivery_type", "estimated_delivery_days", "is_selected" ] }, "carrier_capabilities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "rates": { "type": "string" }, "tracking_events": { "type": "string" } }, "required": [ "id", "carrier", "status", "tracking_code", "carrier_shipment_id", "service_code", "service_name", "order_ref", "pickup_point_id", "sender", "recipient", "parcel", "options", "carrier_options", "rate", "estimated_days", "label_url", "label_format", "selected_rate", "carrier_capabilities", "created_at", "updated_at", "rates", "tracking_events" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments\/{shipment}:generate-label": { "post": { "operationId": "v1.shipments.generate-label", "tags": [ "Shipments" ], "parameters": [ { "name": "shipment", "in": "path", "required": true, "description": "The shipment ID", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "paper_size": { "type": [ "string", "null" ], "enum": [ "A4", "A6" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": {}, "carrier": { "type": "string" }, "status": { "type": "string" }, "tracking_code": { "type": [ "string", "null" ] }, "carrier_shipment_id": { "type": [ "string", "null" ] }, "service_code": { "type": [ "string", "null" ] }, "service_name": { "type": "string" }, "order_ref": { "type": [ "string", "null" ] }, "pickup_point_id": { "type": "null" }, "sender": { "type": "string" }, "recipient": { "type": "string" }, "parcel": { "type": "string" }, "options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "carrier_options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rate": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": [ "string", "null" ] } }, "required": [ "amount", "currency" ] }, "estimated_days": { "type": "string" }, "label_url": { "type": [ "string", "null" ] }, "label_format": { "type": "null" }, "selected_rate": { "type": [ "object", "null" ], "properties": { "id": {}, "carrier": { "type": "string" }, "service_code": { "type": "string" }, "service_label": { "type": [ "string", "null" ] }, "amount": { "type": "integer" }, "currency": { "type": "string" }, "delivery_type": { "type": [ "string", "null" ] }, "estimated_delivery_days": { "type": [ "integer", "null" ] }, "is_selected": { "type": "boolean" } }, "required": [ "id", "carrier", "service_code", "service_label", "amount", "currency", "delivery_type", "estimated_delivery_days", "is_selected" ] }, "carrier_capabilities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "rates": { "type": "string" }, "tracking_events": { "type": "string" } }, "required": [ "id", "carrier", "status", "tracking_code", "carrier_shipment_id", "service_code", "service_name", "order_ref", "pickup_point_id", "sender", "recipient", "parcel", "options", "carrier_options", "rate", "estimated_days", "label_url", "label_format", "selected_rate", "carrier_capabilities", "created_at", "updated_at", "rates", "tracking_events" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments\/{shipment}\/label": { "get": { "operationId": "v1.shipments.label", "tags": [ "Shipments" ], "parameters": [ { "name": "shipment", "in": "path", "required": true, "description": "The shipment ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/pdf": { "schema": { "type": "string" } } }, "headers": { "Content-Disposition": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "string" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments\/{shipment}:cancel": { "post": { "operationId": "v1.shipments.cancel", "tags": [ "Shipments" ], "parameters": [ { "name": "shipment", "in": "path", "required": true, "description": "The shipment ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": {}, "carrier": { "type": "string" }, "status": { "type": "string" }, "tracking_code": { "type": [ "string", "null" ] }, "carrier_shipment_id": { "type": [ "string", "null" ] }, "service_code": { "type": [ "string", "null" ] }, "service_name": { "type": "string" }, "order_ref": { "type": [ "string", "null" ] }, "pickup_point_id": { "type": "null" }, "sender": { "type": "string" }, "recipient": { "type": "string" }, "parcel": { "type": "string" }, "options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "carrier_options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rate": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": [ "string", "null" ] } }, "required": [ "amount", "currency" ] }, "estimated_days": { "type": "string" }, "label_url": { "type": [ "string", "null" ] }, "label_format": { "type": "null" }, "selected_rate": { "type": [ "object", "null" ], "properties": { "id": {}, "carrier": { "type": "string" }, "service_code": { "type": "string" }, "service_label": { "type": [ "string", "null" ] }, "amount": { "type": "integer" }, "currency": { "type": "string" }, "delivery_type": { "type": [ "string", "null" ] }, "estimated_delivery_days": { "type": [ "integer", "null" ] }, "is_selected": { "type": "boolean" } }, "required": [ "id", "carrier", "service_code", "service_label", "amount", "currency", "delivery_type", "estimated_delivery_days", "is_selected" ] }, "carrier_capabilities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "rates": { "type": "string" }, "tracking_events": { "type": "string" } }, "required": [ "id", "carrier", "status", "tracking_code", "carrier_shipment_id", "service_code", "service_name", "order_ref", "pickup_point_id", "sender", "recipient", "parcel", "options", "carrier_options", "rate", "estimated_days", "label_url", "label_format", "selected_rate", "carrier_capabilities", "created_at", "updated_at", "rates", "tracking_events" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments\/{shipment}\/tracking-events": { "get": { "operationId": "v1.shipments.tracking-events", "tags": [ "Shipments" ], "parameters": [ { "name": "shipment", "in": "path", "required": true, "description": "The shipment ID", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} }, "meta": { "type": "object", "properties": { "cursor": { "type": "string" }, "has_more": { "type": "boolean" }, "count": { "type": "integer" } }, "required": [ "cursor", "has_more", "count" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/shipments\/{shipment}\/tracking:refresh": { "post": { "operationId": "v1.shipments.tracking-refresh", "summary": "Trigger a live, on-demand tracking poll for a single shipment against\nits carrier, persist any new events, then return the full timeline.\nBacks the order-metabox \"refresh tracking\" button so the merchant sees\nfresh status without waiting for the scheduled tracking:poll cron", "tags": [ "Shipments" ], "parameters": [ { "name": "shipment", "in": "path", "required": true, "description": "The shipment ID", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} }, "meta": { "type": "object", "properties": { "cursor": { "type": "string" }, "has_more": { "type": "boolean" }, "count": { "type": "integer" } }, "required": [ "cursor", "has_more", "count" ] } }, "required": [ "data", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/webhook-subscriptions": { "get": { "operationId": "v1.webhook-subscriptions.index", "tags": [ "WebhookSubscriptions" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": {} } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.webhook-subscriptions.store", "tags": [ "WebhookSubscriptions" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "events": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "url", "events" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": {} }, "is_active": { "type": "boolean" }, "has_secret": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "secret": { "type": [ "string", "null" ] } }, "required": [ "id", "url", "events", "is_active", "has_secret", "created_at", "updated_at", "secret" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/webhook-subscriptions\/{webhookSubscription}": { "get": { "operationId": "v1.webhook-subscriptions.show", "tags": [ "WebhookSubscriptions" ], "parameters": [ { "name": "webhookSubscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": {} }, "is_active": { "type": "boolean" }, "has_secret": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "url", "events", "is_active", "has_secret", "created_at", "updated_at" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "v1.webhook-subscriptions.destroy", "tags": [ "WebhookSubscriptions" ], "parameters": [ { "name": "webhookSubscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/webhook-subscriptions\/{webhookSubscription}\/test": { "post": { "operationId": "v1.webhook-subscriptions.test", "tags": [ "WebhookSubscriptions" ], "parameters": [ { "name": "webhookSubscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "delivery_id": { "type": "string" }, "success": { "type": "string" }, "response_status": { "type": "string" }, "duration_ms": { "type": "integer" }, "response_body_preview": { "type": "string" } }, "required": [ "delivery_id", "success", "response_status", "duration_ms", "response_body_preview" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/webhook-subscriptions\/{webhookSubscription}\/attempts": { "get": { "operationId": "v1.webhook-subscriptions.attempts", "tags": [ "WebhookSubscriptions" ], "parameters": [ { "name": "webhookSubscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "event": { "type": "string" }, "delivery_id": { "type": "string" }, "response_status": { "type": "string" }, "attempt_number": { "type": "string" }, "status": { "type": "string" }, "attempted_at": { "type": "string" }, "next_retry_at": { "type": "string" }, "created_at": { "type": "string" }, "payload": { "type": "string" } }, "required": [ "id", "event", "delivery_id", "response_status", "attempt_number", "status", "attempted_at", "next_retry_at", "created_at", "payload" ] } } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } } }, "components": { "schemas": { "AddressData": { "type": "object", "properties": { "name": { "type": "string" }, "company": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "country_code": { "type": "string" }, "postal_code": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "street": { "type": "string" }, "street_number": { "type": "string" }, "address_line": { "type": "string" } }, "title": "AddressData" }, "BuildCheckoutOptionsCommand": { "type": "object", "properties": { "sender": { "$ref": "#\/components\/schemas\/AddressData" }, "recipient": { "$ref": "#\/components\/schemas\/AddressData" }, "parcel": { "$ref": "#\/components\/schemas\/ParcelData" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3 }, "carriers": { "type": "array", "items": { "type": "string" } }, "options": { "anyOf": [ { "$ref": "#\/components\/schemas\/ShipmentOptionsData" }, { "type": "null" } ] }, "carrier_options": { "anyOf": [ { "$ref": "#\/components\/schemas\/CarrierOptionsData" }, { "type": "null" } ] }, "radius_km": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "limit_pickup": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 }, "recipient_latitude": { "type": [ "number", "null" ], "minimum": -90, "maximum": 90 }, "recipient_longitude": { "type": [ "number", "null" ], "minimum": -180, "maximum": 180 }, "geocode_recipient": { "type": "boolean" }, "order_total": { "type": [ "integer", "null" ], "minimum": 0 }, "product_categories": { "type": [ "array", "null" ], "items": { "type": "string" } }, "product_shipping_classes": { "type": [ "array", "null" ], "items": { "type": "string" } }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "domain_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "sender", "recipient", "parcel" ], "title": "BuildCheckoutOptionsCommand" }, "CarrierOptionsData": { "type": "object", "properties": { "speedy": { "type": "array", "items": { "type": "string" } }, "econt": { "type": "array", "items": { "type": "string" } }, "boxnow": { "type": "array", "items": { "type": "string" } }, "postone": { "type": "array", "items": { "type": "string" } }, "direx": { "type": "array", "items": { "type": "string" } }, "sameday": { "type": "array", "items": { "type": "string" } }, "bgpost": { "type": "array", "items": { "type": "string" } }, "a1post": { "type": "array", "items": { "type": "string" } }, "pigeon": { "type": "array", "items": { "type": "string" } } }, "required": [ "speedy", "econt", "boxnow", "postone", "direx", "sameday", "bgpost", "a1post", "pigeon" ], "title": "CarrierOptionsData" }, "CarrierRoutingEntry": { "type": "object", "properties": { "delivery_type": { "type": "string" }, "carrier": { "type": "string" }, "priority": { "type": "integer" }, "enabled": { "type": "boolean" } }, "required": [ "delivery_type", "carrier", "priority", "enabled" ], "title": "CarrierRoutingEntry" }, "CodPaymentData": { "type": "object", "properties": { "order_total": { "type": "integer" }, "shipping_total": { "type": "integer" }, "paid_amount": { "type": "integer" }, "currency": { "type": "string" } }, "required": [ "order_total", "shipping_total", "paid_amount", "currency" ], "title": "CodPaymentData" }, "CreateCarrierAccountCommand": { "type": "object", "properties": { "carrier": { "type": "string", "enum": [ "speedy", "econt", "boxnow", "postone", "direx", "sameday", "bgpost", "a1post", "pigeon" ] }, "credentials": { "type": "array", "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_active": { "type": [ "boolean", "null" ] }, "is_test": { "type": [ "boolean", "null" ] }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "domain_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "carrier", "credentials" ], "title": "CreateCarrierAccountCommand" }, "CreateShipmentCommand": { "type": "object", "properties": { "carrier": { "type": "string" }, "to_address": { "$ref": "#\/components\/schemas\/AddressData" }, "parcel": { "$ref": "#\/components\/schemas\/ParcelData" }, "from_address": { "anyOf": [ { "$ref": "#\/components\/schemas\/AddressData" }, { "type": "null" } ] }, "currency": { "type": "string", "minLength": 3, "maxLength": 3 }, "goods": { "type": [ "array", "null" ], "items": { "$ref": "#\/components\/schemas\/GoodsItemData" } }, "carrier_account_id": { "type": [ "string", "null" ], "format": "uuid" }, "service_code": { "type": [ "string", "null" ], "maxLength": 50 }, "options": { "anyOf": [ { "$ref": "#\/components\/schemas\/ShipmentOptionsData" }, { "type": "null" } ] }, "cod": { "anyOf": [ { "$ref": "#\/components\/schemas\/CodPaymentData" }, { "type": "null" } ] }, "carrier_options": { "type": [ "array", "null" ], "items": { "type": "string" } }, "order_ref": { "type": [ "string", "null" ], "maxLength": 255 }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "domain_id": { "type": [ "string", "null" ], "format": "uuid" }, "rate_snapshot": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "carrier", "to_address", "parcel" ], "title": "CreateShipmentCommand" }, "GeocodeAddressCommand": { "type": "object", "properties": { "address": { "type": "string", "minLength": 2, "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "postal_code": { "type": [ "string", "null" ], "maxLength": 20 }, "country": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, "required": [ "address" ], "title": "GeocodeAddressCommand" }, "GoodsItemData": { "type": "object", "properties": { "description": { "type": "string" }, "quantity": { "type": "integer" }, "unit_value": { "type": "integer" }, "unit_weight": { "type": "number" }, "hs_code": { "type": "string" }, "origin_country_code": { "type": "string" } }, "required": [ "description", "quantity", "unit_value" ], "title": "GoodsItemData" }, "NormalizeAddressCommand": { "type": "object", "properties": { "address": { "type": "string", "minLength": 2, "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 100 }, "postal_code": { "type": [ "string", "null" ], "maxLength": 20 }, "country": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 }, "provider": { "type": [ "string", "null" ] }, "api_key": { "type": [ "string", "null" ], "maxLength": 500 }, "model": { "type": [ "string", "null" ], "maxLength": 100 }, "account_id": { "type": [ "string", "null" ], "maxLength": 100 } }, "required": [ "address" ], "title": "NormalizeAddressCommand" }, "ParcelData": { "type": "object", "properties": { "weight": { "type": "number" }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "count": { "type": "integer" }, "description": { "type": "string" } }, "title": "ParcelData" }, "QuoteRatesCommand": { "type": "object", "properties": { "from_address": { "$ref": "#\/components\/schemas\/AddressData" }, "to_address": { "$ref": "#\/components\/schemas\/AddressData" }, "parcel": { "$ref": "#\/components\/schemas\/ParcelData" }, "currency": { "type": "string", "minLength": 3, "maxLength": 3 }, "carriers": { "type": "array", "items": { "type": "string" } }, "options": { "anyOf": [ { "$ref": "#\/components\/schemas\/ShipmentOptionsData" }, { "type": "null" } ] }, "carrier_options": { "anyOf": [ { "$ref": "#\/components\/schemas\/CarrierOptionsData" }, { "type": "null" } ] }, "order_total": { "type": [ "integer", "null" ], "minimum": 0 }, "product_categories": { "type": [ "array", "null" ], "items": { "type": "string" } }, "product_shipping_classes": { "type": [ "array", "null" ], "items": { "type": "string" } }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "domain_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "from_address", "to_address", "parcel" ], "title": "QuoteRatesCommand" }, "ShipmentOptionsData": { "type": "object", "properties": { "note": { "type": "string" }, "saturday_delivery": { "type": "boolean" }, "declared_value": { "type": "integer" }, "declared_value_currency": { "type": "string" }, "fragile": { "type": "boolean" }, "document": { "type": "boolean" }, "cod_amount": { "type": "integer" }, "cod_currency": { "type": "string" } }, "title": "ShipmentOptionsData" }, "TestCarrierConnectionCommand": { "type": "object", "properties": { "carrier_account_id": { "type": [ "string", "null" ], "format": "uuid" }, "carrier": { "type": [ "string", "null" ] }, "credentials": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_test": { "type": [ "boolean", "null" ] } }, "title": "TestCarrierConnectionCommand" }, "UpdateCarrierAccountCommand": { "type": "object", "properties": { "carrier_account_id": { "type": "string", "format": "uuid" }, "credentials": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": "string" } }, "is_active": { "type": [ "boolean", "null" ] }, "is_test": { "type": [ "boolean", "null" ] }, "user_id": { "type": [ "string", "null" ], "format": "uuid" } }, "title": "UpdateCarrierAccountCommand" }, "UpdateCarrierRoutingCommand": { "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CarrierRoutingEntry" } }, "domain_id": { "type": [ "string", "null" ], "format": "uuid" }, "user_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "rules" ], "title": "UpdateCarrierRoutingCommand" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "AuthenticationException": { "description": "Unauthenticated", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }