{ "openapi": "3.1.1", "info": { "title": "Oms.Api | v1", "version": "1.0.0" }, "servers": [ { "url": "http://oms.unifaun.com/api" } ], "paths": { "/address/{id}": { "get": { "tags": [ "Address" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } } } } }, "patch": { "tags": [ "Address" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } } } } }, "delete": { "tags": [ "Address" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } } } } } }, "/address": { "post": { "tags": [ "Address" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } } } } }, "get": { "tags": [ "Address" ], "parameters": [ { "name": "orderId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressDto" } } } } } } }, "/orders/{orderId}/addresses": { "get": { "tags": [ "Address" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressDto" } } } } } } } }, "/Automations": { "get": { "tags": [ "Automations" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationDto" } } } } } } }, "post": { "tags": [ "Automations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAutomationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAutomationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAutomationDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationDto" } } } } } } }, "/Automations/{id}": { "get": { "tags": [ "Automations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationDto" } } } } } }, "put": { "tags": [ "Automations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationDto" } } } } } }, "delete": { "tags": [ "Automations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/Automations/dryrun": { "post": { "tags": [ "Automations" ], "parameters": [ { "name": "orderId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAutomationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAutomationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAutomationDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AutomationDryRunResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutomationDryRunResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutomationDryRunResultDto" } } } } } } }, "/comments/{id}": { "get": { "tags": [ "Comments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommentDto" } } } } } }, "delete": { "tags": [ "Comments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/comments": { "post": { "tags": [ "Comments" ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateCommentDto" } ] } }, "text/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateCommentDto" } ] } }, "application/*+json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateCommentDto" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommentDto" } } } } } } }, "/customers": { "get": { "tags": [ "Customers" ], "parameters": [ { "name": "Cursor", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { } }, { "name": "search", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfCustomerDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfCustomerDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfCustomerDto" } } } } } } }, "/customers/{id}/pull-delivery-settings": { "post": { "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } } } } } } }, "/health": { "get": { "tags": [ "Default" ], "responses": { "200": { "description": "OK" } } } }, "/usertest": { "get": { "tags": [ "Default" ], "responses": { "200": { "description": "OK" } } } }, "/env-vars": { "get": { "tags": [ "Default" ], "responses": { "200": { "description": "OK" } } } }, "/bootstrap-delivery-options": { "post": { "tags": [ "Default" ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/{orderChannelId}/delivery-option-mappings": { "get": { "tags": [ "DeliveryOptionMappings" ], "parameters": [ { "name": "orderChannelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDeliveryOptionMappingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDeliveryOptionMappingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDeliveryOptionMappingDto" } } } } } }, "post": { "tags": [ "DeliveryOptionMappings" ], "parameters": [ { "name": "orderChannelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } } } } } } }, "/order-channels/{orderChannelId}/delivery-option-mappings/{id}": { "get": { "tags": [ "DeliveryOptionMappings" ], "parameters": [ { "name": "orderChannelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } } } } } }, "put": { "tags": [ "DeliveryOptionMappings" ], "parameters": [ { "name": "orderChannelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } } } } } }, "delete": { "tags": [ "DeliveryOptionMappings" ], "parameters": [ { "name": "orderChannelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/delivery-options": { "get": { "tags": [ "DeliveryOptions" ], "parameters": [ { "name": "OrderChannelId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDeliveryOptionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDeliveryOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDeliveryOptionDto" } } } } } }, "post": { "tags": [ "DeliveryOptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } } } } } } }, "/delivery-options/{id}": { "get": { "tags": [ "DeliveryOptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } } } } } }, "put": { "tags": [ "DeliveryOptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } } } } } }, "delete": { "tags": [ "DeliveryOptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeliveryOptionDto" } } } } } } }, "/delivery-options/rates": { "post": { "tags": [ "DeliveryOptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateQuoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RateQuoteDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RateQuoteDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/delivery-options/{id}/pudos": { "post": { "tags": [ "DeliveryOptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPudosDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListPudosDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ListPudosDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/Import": { "post": { "tags": [ "Import" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartImportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StartImportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StartImportRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OkResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OkResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OkResult" } } } } } } }, "/Items/{id}": { "get": { "tags": [ "Items" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ItemDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemDto" } } } } } }, "put": { "tags": [ "Items" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateItemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateItemDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateItemDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ItemDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ItemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemDto" } } } } } }, "delete": { "tags": [ "Items" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/Jobs": { "get": { "tags": [ "Jobs" ], "parameters": [ { "name": "Cursor", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfJobDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfJobDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfJobDto" } } } } } } }, "/order-channels": { "get": { "tags": [ "OrderChannels" ], "parameters": [ { "name": "Cursor", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfOrderChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfOrderChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfOrderChannelDto" } } } } } }, "post": { "tags": [ "OrderChannels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrderChannelDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrderChannelDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } } } } } } }, "/order-channels/{id}": { "get": { "tags": [ "OrderChannels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } } } } } }, "patch": { "tags": [ "OrderChannels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderChannelDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOrderChannelDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } } } } } }, "put": { "tags": [ "OrderChannels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderChannelDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOrderChannelDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderChannelDto" } } } } } }, "delete": { "tags": [ "OrderChannels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/{id}/attributes/{attributeKey}": { "put": { "tags": [ "OrderChannels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attributeKey", "in": "path", "required": true, "schema": { } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderChannelAttributeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderChannelAttributeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOrderChannelAttributeDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderChannelAttributeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderChannelAttributeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderChannelAttributeDto" } } } } } } }, "/order-channels/types": { "get": { "tags": [ "OrderChannels" ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/all": { "get": { "tags": [ "OrderChannels" ], "parameters": [ { "name": "CustomerId", "in": "query", "schema": { } }, { "name": "Search", "in": "query", "schema": { } }, { "name": "Cursor", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAdminOrderChannelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAdminOrderChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAdminOrderChannelDto" } } } } } } }, "/Orders": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "Search", "in": "query", "schema": { } }, { "name": "ExternalReference", "in": "query", "schema": { } }, { "name": "VisibleReference", "in": "query", "schema": { } }, { "name": "CreatedAt", "in": "query", "schema": { } }, { "name": "Status", "in": "query", "schema": { } }, { "name": "OrderChannel", "in": "query", "schema": { } }, { "name": "IsLocked", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsReturn", "in": "query", "schema": { "type": "boolean" } }, { "name": "ReceiverCountry", "in": "query", "schema": { } }, { "name": "Tag", "in": "query", "schema": { } }, { "name": "Sku", "in": "query", "schema": { } }, { "name": "DeliveryOption", "in": "query", "schema": { } }, { "name": "NumberOfItems", "in": "query", "schema": { } }, { "name": "ParsedExternalReference.Operator", "in": "query", "schema": { "enum": [ "EQ", "NEQ", "CONTAINS" ] } }, { "name": "ParsedExternalReference.Value", "in": "query", "schema": { } }, { "name": "ParsedVisibleReference.Operator", "in": "query", "schema": { "enum": [ "EQ", "NEQ", "CONTAINS" ] } }, { "name": "ParsedVisibleReference.Value", "in": "query", "schema": { } }, { "name": "ParsedStatuses.Include", "in": "query", "schema": { "type": "array", "items": { "enum": [ "PENDING", "DISPATCHED", "PARTLY_DISPATCHED", "CANCELLED", "ERROR", "MISSING_DELIVERY_OPTION" ] } } }, { "name": "ParsedStatuses.Exclude", "in": "query", "schema": { "type": "array", "items": { "enum": [ "PENDING", "DISPATCHED", "PARTLY_DISPATCHED", "CANCELLED", "ERROR", "MISSING_DELIVERY_OPTION" ] } } }, { "name": "ParsedOrderChannels.Include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ParsedOrderChannels.Exclude", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ParsedReceiverCountry.Include", "in": "query", "schema": { "type": "array", "items": { "enum": [ "AF", "AL", "AQ", "DZ", "AS", "AD", "AO", "AG", "AZ", "AR", "AU", "AT", "BS", "BH", "BD", "AM", "BB", "BE", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "BZ", "IO", "SB", "VG", "BN", "BG", "MM", "BI", "BY", "KH", "CM", "CA", "CV", "KY", "CF", "LK", "TD", "CL", "CN", "TW", "CX", "CC", "CO", "KM", "YT", "CG", "CD", "CK", "CR", "HR", "CU", "CY", "CZ", "BJ", "DK", "DM", "DO", "EC", "SV", "GQ", "ET", "ER", "EE", "FO", "FK", "GS", "FJ", "FI", "AX", "FR", "GF", "PF", "TF", "DJ", "GA", "GE", "GM", "PS", "DE", "GH", "GI", "KI", "GR", "GL", "GD", "GP", "GU", "GT", "GN", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IL", "IT", "CI", "JM", "JP", "KZ", "JO", "KE", "KP", "KR", "KW", "KG", "LA", "LB", "LS", "LV", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MQ", "MR", "MU", "MX", "MC", "MN", "MD", "ME", "MS", "MA", "MZ", "OM", "NA", "NR", "NP", "NL", "CW", "AW", "SX", "BQ", "NC", "VU", "NZ", "NI", "NE", "NG", "NU", "NF", "NO", "MP", "UM", "FM", "MH", "PW", "PK", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "GW", "TL", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "AI", "LC", "MF", "PM", "VC", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "VN", "SI", "SO", "ZA", "ZW", "ES", "SS", "SD", "EH", "SR", "SJ", "SZ", "SE", "CH", "SY", "TJ", "TH", "TG", "TK", "TO", "TT", "AE", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "MK", "EG", "GB", "GG", "JE", "IM", "TZ", "US", "VI", "BF", "UY", "UZ", "VE", "WF", "WS", "YE", "ZM" ] } } }, { "name": "ParsedReceiverCountry.Exclude", "in": "query", "schema": { "type": "array", "items": { "enum": [ "AF", "AL", "AQ", "DZ", "AS", "AD", "AO", "AG", "AZ", "AR", "AU", "AT", "BS", "BH", "BD", "AM", "BB", "BE", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "BZ", "IO", "SB", "VG", "BN", "BG", "MM", "BI", "BY", "KH", "CM", "CA", "CV", "KY", "CF", "LK", "TD", "CL", "CN", "TW", "CX", "CC", "CO", "KM", "YT", "CG", "CD", "CK", "CR", "HR", "CU", "CY", "CZ", "BJ", "DK", "DM", "DO", "EC", "SV", "GQ", "ET", "ER", "EE", "FO", "FK", "GS", "FJ", "FI", "AX", "FR", "GF", "PF", "TF", "DJ", "GA", "GE", "GM", "PS", "DE", "GH", "GI", "KI", "GR", "GL", "GD", "GP", "GU", "GT", "GN", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IL", "IT", "CI", "JM", "JP", "KZ", "JO", "KE", "KP", "KR", "KW", "KG", "LA", "LB", "LS", "LV", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MQ", "MR", "MU", "MX", "MC", "MN", "MD", "ME", "MS", "MA", "MZ", "OM", "NA", "NR", "NP", "NL", "CW", "AW", "SX", "BQ", "NC", "VU", "NZ", "NI", "NE", "NG", "NU", "NF", "NO", "MP", "UM", "FM", "MH", "PW", "PK", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "GW", "TL", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "AI", "LC", "MF", "PM", "VC", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "VN", "SI", "SO", "ZA", "ZW", "ES", "SS", "SD", "EH", "SR", "SJ", "SZ", "SE", "CH", "SY", "TJ", "TH", "TG", "TK", "TO", "TT", "AE", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "MK", "EG", "GB", "GG", "JE", "IM", "TZ", "US", "VI", "BF", "UY", "UZ", "VE", "WF", "WS", "YE", "ZM" ] } } }, { "name": "ParsedTags.Include", "in": "query", "schema": { "type": "array" } }, { "name": "ParsedTags.Exclude", "in": "query", "schema": { "type": "array" } }, { "name": "ParsedSku", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StringFilterTerm" } } }, { "name": "ParsedDeliveryOptions.Include", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ParsedDeliveryOptions.Exclude", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ParsedNumberOfItems", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberFilterTerm" } } }, { "name": "Cursor", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfOrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfOrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfOrderDto" } } } } } }, "post": { "tags": [ "Orders" ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOrderDto" } ] } }, "text/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOrderDto" } ] } }, "application/*+json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOrderDto" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } } } } }, "/Orders/{id}": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } } } }, "put": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateOrderDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } } } }, "delete": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } } } } }, "/Orders/{id}/delivery-option": { "put": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveDeliveryOptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolveDeliveryOptionDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResolveDeliveryOptionDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } } } } }, "/Orders/{id}/timeline": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTimelineDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTimelineDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTimelineDto" } } } } } } } }, "/Parcels/{id}": { "get": { "tags": [ "Parcels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ParcelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ParcelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ParcelDto" } } } } } }, "put": { "tags": [ "Parcels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParcelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateParcelDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateParcelDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ParcelDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ParcelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ParcelDto" } } } } } }, "delete": { "tags": [ "Parcels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/saved-order-filters": { "get": { "tags": [ "SavedOrderFilters" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SavedOrderFilterDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SavedOrderFilterDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SavedOrderFilterDto" } } } } } } }, "post": { "tags": [ "SavedOrderFilters" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSavedOrderFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSavedOrderFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSavedOrderFilterDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SavedOrderFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SavedOrderFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SavedOrderFilterDto" } } } } } } }, "/saved-order-filters/{id}": { "get": { "tags": [ "SavedOrderFilters" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SavedOrderFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SavedOrderFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SavedOrderFilterDto" } } } } } }, "patch": { "tags": [ "SavedOrderFilters" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSavedOrderFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSavedOrderFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSavedOrderFilterDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SavedOrderFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SavedOrderFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SavedOrderFilterDto" } } } } } }, "delete": { "tags": [ "SavedOrderFilters" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/Shipments": { "post": { "tags": [ "Shipments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateShipmentDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/Shipments/events": { "post": { "tags": [ "Shipments" ], "parameters": [ { "name": "x-apikey", "in": "header", "schema": { } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentEventDto" } } ] } }, "text/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentEventDto" } } ] } }, "application/*+json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentEventDto" } } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/Webhooks": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "Subject", "in": "query", "schema": { } }, { "name": "IsActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "OrderChannel", "in": "query", "schema": { } }, { "name": "Search", "in": "query", "schema": { } }, { "name": "ParsedSubjects", "in": "query", "schema": { "type": "array", "items": { "enum": [ "ORDER_CREATED", "ORDER_UPDATED", "ORDER_DELETED", "SHIPMENT_CREATED" ] } } }, { "name": "ParsedOrderChannels", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Cursor", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookDto" } } } } } }, "post": { "tags": [ "Webhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWebhookDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookCreatedDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreatedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookCreatedDto" } } } } } } }, "/Webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookDto" } } } } } }, "put": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookDto" } } } } } }, "delete": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/Webhooks/{id}/events": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Status", "in": "query", "schema": { } }, { "name": "Search", "in": "query", "schema": { } }, { "name": "OrderId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "ParsedStatuses", "in": "query", "schema": { "type": "array", "items": { "enum": [ "PENDING", "SUCCESS", "FAILED", "RETRYING" ] } } }, { "name": "Cursor", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookEventDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookEventDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookEventDto" } } } } } } }, "/Webhooks/{id}/events/{webhookEventId}": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "webhookEventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookEventDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDto" } } } } } } }, "/Webhooks/{id}/test": { "post": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookEventDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDto" } } } } } } }, "/Webhooks/{id}/events/{webhookEventId}/resend": { "post": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "webhookEventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookEventDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDto" } } } } } } }, "/Webhooks/{id}/rotate-secret": { "post": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookSecretRotatedDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSecretRotatedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookSecretRotatedDto" } } } } } } }, "/order-channels/shopify/webhooks": { "post": { "tags": [ "Shopify" ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/shopify/{orderChannelId}/refresh-tokens": { "post": { "tags": [ "Shopify" ], "parameters": [ { "name": "orderChannelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/shopify/rates": { "post": { "tags": [ "Shopify" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShopifyShippingRate" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShopifyShippingRate" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShopifyShippingRate" } } } } } } } }, "/order-channels/shopify/connect": { "get": { "tags": [ "ShopifySetup" ], "parameters": [ { "name": "shop", "in": "query", "schema": { } }, { "name": "embedded", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/shopify/callback": { "get": { "tags": [ "ShopifySetup" ], "parameters": [ { "name": "shop", "in": "query", "schema": { } }, { "name": "code", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/woocommerce/order-updated": { "post": { "tags": [ "WooCommerce" ], "parameters": [ { "name": "ocid", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/woocommerce/rates": { "post": { "tags": [ "WooCommerce" ], "parameters": [ { "name": "ocid", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/woocommerce/pudos": { "post": { "tags": [ "WooCommerce" ], "parameters": [ { "name": "ocid", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/woocommerce/connect": { "get": { "tags": [ "WooCommerceSetup" ], "parameters": [ { "name": "shopUrl", "in": "query", "schema": { } } ], "responses": { "200": { "description": "OK" } } } }, "/order-channels/woocommerce/callback": { "post": { "tags": [ "WooCommerceSetup" ], "parameters": [ { "name": "shopUrl", "in": "query", "schema": { } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupCallbackRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetupCallbackRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetupCallbackRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "ActionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "UPDATE_RECORD", "ADD_TAG" ] }, "args": { }, "priority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "AddressDto": { "required": [ "type", "address1", "country" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AddressType" } ] }, "address1": { }, "address2": { }, "country": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Country" } ] }, "zipCode": { }, "city": { }, "state": { }, "firstName": { }, "lastName": { }, "companyName": { }, "mobile": { }, "phone": { }, "email": { }, "reference": { }, "vatNo": { }, "eoriNo": { }, "orgNo": { }, "orderId": { "type": "string", "format": "uuid" } } }, "AddressType": { "enum": [ "RECEIVER", "SENDER", "PUDO", "BILLING", null ] }, "AdminOrderChannelDto": { "type": "object", "properties": { "customerId": { }, "customerName": { }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "format": "date-time" }, "updatedAt": { "format": "date-time" }, "name": { }, "integration": { }, "integrationReference": { }, "attributes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OrderChannelAttributeDto" } }, "isEnabled": { "type": "boolean" }, "isSendAutomatically": { "type": "boolean" }, "isFulfillAutomatically": { "type": "boolean" }, "pudoLimit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "AutomationDryRunResultDto": { "type": "object", "properties": { "orderChannelIdMatches": { "type": "boolean" }, "conditionMet": { "type": "boolean" }, "before": { "$ref": "#/components/schemas/OrderDto" }, "after": { "$ref": "#/components/schemas/OrderDto" } } }, "AutomationDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { }, "priority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isEnabled": { "type": "boolean" }, "status": { "enum": [ "ACTIVE", "ERROR" ] }, "errorMessage": { }, "eventType": { "enum": [ "CREATED", "UPDATED" ] }, "condition": { }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionDto" } }, "orderChannelIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "CommentDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "format": "date-time" }, "author": { }, "type": { "enum": [ "INTERNAL", "EXTERNAL" ] }, "value": { } } }, "CommentType": { "enum": [ "INTERNAL", "EXTERNAL", null ] }, "Country": { "enum": [ "AF", "AL", "AQ", "DZ", "AS", "AD", "AO", "AG", "AZ", "AR", "AU", "AT", "BS", "BH", "BD", "AM", "BB", "BE", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "BZ", "IO", "SB", "VG", "BN", "BG", "MM", "BI", "BY", "KH", "CM", "CA", "CV", "KY", "CF", "LK", "TD", "CL", "CN", "TW", "CX", "CC", "CO", "KM", "YT", "CG", "CD", "CK", "CR", "HR", "CU", "CY", "CZ", "BJ", "DK", "DM", "DO", "EC", "SV", "GQ", "ET", "ER", "EE", "FO", "FK", "GS", "FJ", "FI", "AX", "FR", "GF", "PF", "TF", "DJ", "GA", "GE", "GM", "PS", "DE", "GH", "GI", "KI", "GR", "GL", "GD", "GP", "GU", "GT", "GN", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IL", "IT", "CI", "JM", "JP", "KZ", "JO", "KE", "KP", "KR", "KW", "KG", "LA", "LB", "LS", "LV", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MQ", "MR", "MU", "MX", "MC", "MN", "MD", "ME", "MS", "MA", "MZ", "OM", "NA", "NR", "NP", "NL", "CW", "AW", "SX", "BQ", "NC", "VU", "NZ", "NI", "NE", "NG", "NU", "NF", "NO", "MP", "UM", "FM", "MH", "PW", "PK", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "GW", "TL", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "AI", "LC", "MF", "PM", "VC", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "VN", "SI", "SO", "ZA", "ZW", "ES", "SS", "SD", "EH", "SR", "SJ", "SZ", "SE", "CH", "SY", "TJ", "TH", "TG", "TK", "TO", "TT", "AE", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "MK", "EG", "GB", "GG", "JE", "IM", "TZ", "US", "VI", "BF", "UY", "UZ", "VE", "WF", "WS", "YE", "ZM", null ] }, "CreateActionDto": { "type": "object", "properties": { "type": { "enum": [ "UPDATE_RECORD", "ADD_TAG" ] }, "args": { }, "priority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "CreateAutomationDto": { "type": "object", "properties": { "name": { }, "priority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isEnabled": { "type": "boolean" }, "eventType": { "enum": [ "CREATED", "UPDATED" ] }, "condition": { }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/CreateActionDto" } }, "orderChannelIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "CreateCommentDto": { "required": [ "orderId", "type", "value" ], "type": "object", "properties": { "orderId": { "type": [ "null", "string" ], "format": "uuid" }, "type": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CommentType" } ] }, "value": { } } }, "CreateItemDto": { "required": [ "quantity", "description", "unitPrice" ], "type": "object", "properties": { "parcelId": { "type": "string", "format": "uuid" }, "externalReference": { }, "quantity": { "maximum": 10000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "status": { "enum": [ "PENDING" ] }, "isReturnable": { "type": [ "null", "boolean" ] }, "sku": { }, "isPhysical": { "type": [ "null", "boolean" ] }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "weightUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightUnit" } ] }, "description": { }, "location": { }, "tariffNumber": { "maxLength": 32, "minLength": 6 }, "countryOfOrigin": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Country" } ] }, "vatPercentage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "unitPrice": { "maximum": 9999999, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "discountedUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "discountType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DiscountType" } ] }, "discountValue": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "meta": { "type": [ "null", "object" ] } } }, "CreateOrderChannelAttributeDto": { "type": "object", "properties": { "orderChannelId": { "type": "string", "format": "uuid" }, "key": { }, "value": { }, "description": { }, "isHidden": { "type": "boolean" } } }, "CreateOrderChannelDto": { "type": "object", "properties": { "name": { }, "integration": { }, "integrationReference": { }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrderChannelAttributeDto" } }, "isEnabled": { "type": "boolean" }, "isSendAutomatically": { "type": "boolean" }, "isFulfillAutomatically": { "type": "boolean" }, "pudoLimit": { "maximum": 20, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "CreateOrderDto": { "required": [ "orderChannelId", "currency", "parcels" ], "type": "object", "properties": { "orderChannelId": { "type": [ "null", "string" ], "format": "uuid" }, "visibleReference": { }, "externalReference": { }, "status": { "enum": [ "PENDING", "DISPATCHED", "PARTLY_DISPATCHED", "CANCELLED", "ERROR", "MISSING_DELIVERY_OPTION" ] }, "isLocked": { "type": "boolean" }, "isReturn": { "type": "boolean" }, "currency": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Currency" } ] }, "tags": { "type": "array" }, "meta": { "type": "object" }, "parcels": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CreateParcelDto" } }, "addresses": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AddressDto" } } } }, "CreateParcelDto": { "type": "object", "properties": { "orderId": { "type": "string", "format": "uuid" }, "description": { }, "isFulfilled": { "type": "boolean" }, "type": { "enum": [ "CARDBOARD" ] }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "weightUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightUnit" } ] }, "width": { "maximum": 10000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "height": { "maximum": 10000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "length": { "maximum": 10000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "dimensionUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DimensionUnit" } ] }, "palletType": { "enum": [ "BOX", "EURO" ] }, "shipmentId": { }, "deliveryOption": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ParcelUpdateDeliveryOptionDto" } ] }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CreateItemDto" } } } }, "CreateSavedOrderFilterDto": { "required": [ "name", "filters" ], "type": "object", "properties": { "name": { }, "filters": { "type": "object" } } }, "CreateShipmentDto": { "type": "object", "properties": { "orderId": { "type": "string", "format": "uuid" }, "parcelIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "isStoredShipment": { "type": "boolean" }, "deliveryOption": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ShipmentDeliveryOptionDto" } ] } } }, "CreateWebhookDto": { "required": [ "url", "subject" ], "type": "object", "properties": { "url": { }, "subject": { "enum": [ "ORDER_CREATED", "ORDER_UPDATED", "ORDER_DELETED", "SHIPMENT_CREATED" ] }, "label": { }, "orderChannelIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "Currency": { "enum": [ "ALL", "DZD", "ARS", "AUD", "BSD", "BHD", "BDT", "AMD", "BBD", "BMD", "BTN", "BOB", "BWP", "BZD", "SBD", "BND", "MMK", "BIF", "KHR", "CAD", "CVE", "KYD", "LKR", "CLP", "CNY", "COP", "KMF", "CRC", "CUP", "CZK", "DKK", "DOP", "SVC", "ETB", "ERN", "FKP", "FJD", "DJF", "GMD", "GIP", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "KZT", "JOD", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MWK", "MYR", "MVR", "MUR", "MXN", "MNT", "MDL", "MAD", "OMR", "NAD", "NPR", "XCG", "AWG", "VUV", "NZD", "NIO", "NGN", "NOK", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "QAR", "RUB", "RWF", "SHP", "SAR", "SCR", "SGD", "VND", "SOS", "ZAR", "SSP", "SZL", "SEK", "CHF", "SYP", "THB", "TOP", "TTD", "AED", "TND", "UGX", "MKD", "EGP", "GBP", "TZS", "USD", "UYU", "UZS", "WST", "YER", "TWD", "ZWG", "SLE", "VED", "VES", "MRU", "STN", "BYN", "TMT", "GHS", "SDG", "RSD", "MZN", "AZN", "RON", "TRY", "XAF", "XCD", "XOF", "XPF", "ZMW", "SRD", "MGA", "AFN", "TJS", "AOA", "BGN", "CDF", "BAM", "EUR", "UAH", "GEL", "PLN", "BRL", null ] }, "CustomerDto": { "type": "object", "properties": { "id": { }, "name": { }, "anonymizationTimeMonths": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "availableAutomations": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "orderChannels": { "type": "array", "items": { "$ref": "#/components/schemas/OrderChannelDto" } } } }, "DeliveryOptionAddonDto": { "type": "object", "properties": { "key": { }, "attributes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/KeyValuePairOfstringAndstring" } } } }, "DeliveryOptionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "orderChannelId": { "type": "string", "format": "uuid" }, "index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "name": { }, "description": { }, "isEnabled": { "type": "boolean" }, "isTest": { "type": "boolean" }, "isPudo": { "type": "boolean" }, "carrierId": { }, "serviceId": { }, "senderId": { }, "packingTypeId": { }, "printSet": { "type": [ "null", "array" ] }, "weightUnit": { "enum": [ "G", "KG", "OZ", "LBS" ] }, "length": { "maximum": 99999, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "width": { "maximum": 99999, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "height": { "maximum": 99999, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "dimensionUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DimensionUnit" } ] }, "addons": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryOptionAddonDto" } }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryZoneDto" } } } }, "DeliveryOptionMappingDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "orderChannelId": { "type": "string", "format": "uuid" }, "code": { }, "deliveryOptionId": { "type": "string", "format": "uuid" } } }, "DeliveryRateDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "condition": { }, "currency": { "enum": [ "ALL", "DZD", "ARS", "AUD", "BSD", "BHD", "BDT", "AMD", "BBD", "BMD", "BTN", "BOB", "BWP", "BZD", "SBD", "BND", "MMK", "BIF", "KHR", "CAD", "CVE", "KYD", "LKR", "CLP", "CNY", "COP", "KMF", "CRC", "CUP", "CZK", "DKK", "DOP", "SVC", "ETB", "ERN", "FKP", "FJD", "DJF", "GMD", "GIP", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "KZT", "JOD", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MWK", "MYR", "MVR", "MUR", "MXN", "MNT", "MDL", "MAD", "OMR", "NAD", "NPR", "XCG", "AWG", "VUV", "NZD", "NIO", "NGN", "NOK", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "QAR", "RUB", "RWF", "SHP", "SAR", "SCR", "SGD", "VND", "SOS", "ZAR", "SSP", "SZL", "SEK", "CHF", "SYP", "THB", "TOP", "TTD", "AED", "TND", "UGX", "MKD", "EGP", "GBP", "TZS", "USD", "UYU", "UZS", "WST", "YER", "TWD", "ZWG", "SLE", "VED", "VES", "MRU", "STN", "BYN", "TMT", "GHS", "SDG", "RSD", "MZN", "AZN", "RON", "TRY", "XAF", "XCD", "XOF", "XPF", "ZMW", "SRD", "MGA", "AFN", "TJS", "AOA", "BGN", "CDF", "BAM", "EUR", "UAH", "GEL", "PLN", "BRL" ] }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "float" } } }, "DeliveryZoneDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "countries": { "type": "array" }, "zipCodes": { "type": "array" }, "rates": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryRateDto" } } } }, "DimensionUnit": { "enum": [ "MM", "CM", "M", "IN", "YD", null ] }, "DiscountType": { "enum": [ "FIXED", null ] }, "ItemDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parcelId": { "type": "string", "format": "uuid" }, "externalReference": { }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "enum": [ "PENDING" ] }, "isReturnable": { "type": [ "null", "boolean" ] }, "sku": { }, "isPhysical": { "type": [ "null", "boolean" ] }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "weightUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightUnit" } ] }, "description": { }, "location": { }, "tariffNumber": { }, "countryOfOrigin": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Country" } ] }, "vatPercentage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "unitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "discountedUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "discountType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DiscountType" } ] }, "discountValue": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "meta": { "type": "object" } } }, "JobDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { }, "payload": { }, "status": { }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/JobEventDto" } }, "createdAt": { "format": "date-time" } } }, "JobEventDto": { "type": "object", "properties": { "type": { }, "message": { }, "createdAt": { "format": "date-time" } } }, "KeyValuePairOfstringAndstring": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { }, "value": { } } }, "ListPudosDto": { "required": [ "receiverAddress" ], "type": "object", "properties": { "receiverAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PudoAddressDto" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PudoItemDto" } } } }, "NumberFilterTerm": { "required": [ "operator", "value" ], "type": "object", "properties": { "operator": { "enum": [ "EQ", "GT", "GTE", "LT", "LTE" ] }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "OkResult": { "type": "object", "properties": { "statusCode": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "OrderChannelAttribute": { "type": "object", "properties": { "orderChannelId": { "type": "string", "format": "uuid" }, "key": { }, "value": { }, "kind": { "enum": [ "STRING", "PASSWORD", "BOOL", "INT" ] }, "isHidden": { "type": "boolean" }, "description": { }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "format": "date-time" }, "updatedAt": { "format": "date-time" } } }, "OrderChannelAttributeDto": { "type": "object", "properties": { "key": { }, "kind": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderChannelAttributeKind" } ] }, "value": { } } }, "OrderChannelAttributeKind": { "enum": [ "STRING", "PASSWORD", "BOOL", "INT", null ] }, "OrderChannelDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "format": "date-time" }, "updatedAt": { "format": "date-time" }, "name": { }, "integration": { }, "integrationReference": { }, "attributes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OrderChannelAttributeDto" } }, "isEnabled": { "type": "boolean" }, "isSendAutomatically": { "type": "boolean" }, "isFulfillAutomatically": { "type": "boolean" }, "pudoLimit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "OrderDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "orderChannelId": { "type": "string", "format": "uuid" }, "visibleReference": { }, "externalReference": { }, "comments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CommentDto" } }, "status": { "enum": [ "PENDING", "DISPATCHED", "PARTLY_DISPATCHED", "CANCELLED", "ERROR", "MISSING_DELIVERY_OPTION" ] }, "isLocked": { "type": "boolean" }, "isReturn": { "type": "boolean" }, "currency": { "enum": [ "ALL", "DZD", "ARS", "AUD", "BSD", "BHD", "BDT", "AMD", "BBD", "BMD", "BTN", "BOB", "BWP", "BZD", "SBD", "BND", "MMK", "BIF", "KHR", "CAD", "CVE", "KYD", "LKR", "CLP", "CNY", "COP", "KMF", "CRC", "CUP", "CZK", "DKK", "DOP", "SVC", "ETB", "ERN", "FKP", "FJD", "DJF", "GMD", "GIP", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "KZT", "JOD", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MWK", "MYR", "MVR", "MUR", "MXN", "MNT", "MDL", "MAD", "OMR", "NAD", "NPR", "XCG", "AWG", "VUV", "NZD", "NIO", "NGN", "NOK", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "QAR", "RUB", "RWF", "SHP", "SAR", "SCR", "SGD", "VND", "SOS", "ZAR", "SSP", "SZL", "SEK", "CHF", "SYP", "THB", "TOP", "TTD", "AED", "TND", "UGX", "MKD", "EGP", "GBP", "TZS", "USD", "UYU", "UZS", "WST", "YER", "TWD", "ZWG", "SLE", "VED", "VES", "MRU", "STN", "BYN", "TMT", "GHS", "SDG", "RSD", "MZN", "AZN", "RON", "TRY", "XAF", "XCD", "XOF", "XPF", "ZMW", "SRD", "MGA", "AFN", "TJS", "AOA", "BGN", "CDF", "BAM", "EUR", "UAH", "GEL", "PLN", "BRL" ] }, "tags": { "type": "array" }, "meta": { "type": [ "null", "object" ] }, "addresses": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AddressDto" } }, "parcels": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ParcelDto" } }, "originalDeliveryOption": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OriginalDeliveryOptionDto" } ] }, "createdAt": { "format": "date-time" }, "updatedAt": { "format": "date-time" } } }, "OrderTimelineDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "format": "date-time" }, "type": { "enum": [ "NONE", "CREATED", "UPDATED", "DELETED", "STATUS_CHANGE", "LOCKED", "UNLOCKED", "ERROR", "COMMENT" ] }, "source": { }, "correlationId": { }, "initiator": { }, "message": { "type": [ "null", "array" ] } } }, "OriginalDeliveryOptionDto": { "type": "object", "properties": { "name": { }, "code": { } } }, "PaginatedListOfAdminOrderChannelDto": { "required": [ "cursor", "limit", "offset", "total", "results" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "format": "uuid" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AdminOrderChannelDto" } } } }, "PaginatedListOfCustomerDto": { "required": [ "cursor", "limit", "offset", "total", "results" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "format": "uuid" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDto" } } } }, "PaginatedListOfDeliveryOptionDto": { "required": [ "cursor", "limit", "offset", "total", "results" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "format": "uuid" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryOptionDto" } } } }, "PaginatedListOfDeliveryOptionMappingDto": { "required": [ "cursor", "limit", "offset", "total", "results" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "format": "uuid" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryOptionMappingDto" } } } }, "PaginatedListOfJobDto": { "required": [ "cursor", "limit", "offset", "total", "results" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "format": "uuid" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JobDto" } } } }, "PaginatedListOfOrderChannelDto": { "required": [ "cursor", "limit", "offset", "total", "results" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "format": "uuid" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OrderChannelDto" } } } }, "PaginatedListOfOrderDto": { "required": [ "cursor", "limit", "offset", "total", "results" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "format": "uuid" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDto" } } } }, "PaginatedListOfWebhookDto": { "required": [ "cursor", "limit", "offset", "total", "results" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "format": "uuid" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDto" } } } }, "PaginatedListOfWebhookEventDto": { "required": [ "cursor", "limit", "offset", "total", "results" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "format": "uuid" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventDto" } } } }, "ParcelDeliveryOptionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { } } }, "ParcelDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "orderId": { "type": [ "null", "string" ], "format": "uuid" }, "description": { }, "isFulfilled": { "type": "boolean" }, "type": { "enum": [ "CARDBOARD" ] }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "weightUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightUnit" } ] }, "width": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "length": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "dimensionUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DimensionUnit" } ] }, "palletType": { "enum": [ "BOX", "EURO" ] }, "deliveryOption": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ParcelDeliveryOptionDto" } ] }, "trackingNumber": { }, "trackingUrl": { }, "shipmentId": { }, "shippedAt": { "format": "date-time" }, "isStored": { "type": "boolean" }, "createdAt": { "format": "date-time" }, "updatedAt": { "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDto" } } } }, "ParcelUpdateDeliveryOptionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "PudoAddressDto": { "required": [ "country" ], "type": "object", "properties": { "country": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Country" } ] }, "zipCode": { }, "city": { }, "address1": { } } }, "PudoItemDto": { "required": [ "quantity", "unitPrice" ], "type": "object", "properties": { "quantity": { "maximum": 10000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "unitPrice": { "maximum": 9999999, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "weightUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightUnit" } ] } } }, "RateQuoteAddressDto": { "required": [ "country" ], "type": "object", "properties": { "address1": { }, "address2": { }, "city": { }, "zipCode": { }, "country": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Country" } ] } } }, "RateQuoteDto": { "required": [ "orderChannelId", "deliveryAddress" ], "type": "object", "properties": { "orderChannelId": { "type": [ "null", "string" ], "format": "uuid" }, "deliveryAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RateQuoteAddressDto" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RateQuoteItemDto" } } } }, "RateQuoteItemDto": { "type": "object", "properties": { "description": { }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "float" }, "unitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "float" }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "weightUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightUnit" } ] } } }, "ResolveDeliveryOptionDto": { "type": "object", "properties": { "deliveryOptionId": { "type": "string", "format": "uuid" }, "saveAsMapping": { "type": "boolean" } } }, "SavedOrderFilterDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { }, "filters": { "type": "object" }, "createdAt": { "format": "date-time" }, "updatedAt": { "format": "date-time" } } }, "SetupCallbackRequest": { "type": "object", "properties": { "key_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "user_id": { }, "consumer_key": { }, "consumer_secret": { }, "key_permissions": { } } }, "ShipmentDeliveryOptionDto": { "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "addons": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeliveryOptionAddonDto" } } } }, "ShipmentEventDto": { "type": "object", "properties": { "shipmentId": { }, "storedShipmentId": { }, "accountId": { }, "event": { }, "trackingUrl": { }, "createdAt": { "format": "date-time" } } }, "ShopifyShippingRate": { "type": "object", "properties": { "serviceCode": { }, "serviceName": { }, "totalPrice": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": { }, "currency": { "enum": [ "ALL", "DZD", "ARS", "AUD", "BSD", "BHD", "BDT", "AMD", "BBD", "BMD", "BTN", "BOB", "BWP", "BZD", "SBD", "BND", "MMK", "BIF", "KHR", "CAD", "CVE", "KYD", "LKR", "CLP", "CNY", "COP", "KMF", "CRC", "CUP", "CZK", "DKK", "DOP", "SVC", "ETB", "ERN", "FKP", "FJD", "DJF", "GMD", "GIP", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "KZT", "JOD", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MWK", "MYR", "MVR", "MUR", "MXN", "MNT", "MDL", "MAD", "OMR", "NAD", "NPR", "XCG", "AWG", "VUV", "NZD", "NIO", "NGN", "NOK", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "QAR", "RUB", "RWF", "SHP", "SAR", "SCR", "SGD", "VND", "SOS", "ZAR", "SSP", "SZL", "SEK", "CHF", "SYP", "THB", "TOP", "TTD", "AED", "TND", "UGX", "MKD", "EGP", "GBP", "TZS", "USD", "UYU", "UZS", "WST", "YER", "TWD", "ZWG", "SLE", "VED", "VES", "MRU", "STN", "BYN", "TMT", "GHS", "SDG", "RSD", "MZN", "AZN", "RON", "TRY", "XAF", "XCD", "XOF", "XPF", "ZMW", "SRD", "MGA", "AFN", "TJS", "AOA", "BGN", "CDF", "BAM", "EUR", "UAH", "GEL", "PLN", "BRL" ] } } }, "StartImportRequest": { "required": [ "orderChannelId" ], "type": "object", "properties": { "orderChannelId": { "type": "string", "format": "uuid" } } }, "StringFilterTerm": { "required": [ "operator", "value" ], "type": "object", "properties": { "operator": { "enum": [ "EQ", "NEQ", "CONTAINS" ] }, "value": { } } }, "UpdateAutomationDto": { "type": "object", "properties": { "name": { }, "priority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isEnabled": { "type": "boolean" }, "eventType": { "enum": [ "CREATED", "UPDATED" ] }, "condition": { }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/CreateActionDto" } }, "orderChannelIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "UpdateItemDto": { "required": [ "quantity", "description", "unitPrice" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "parcelId": { "type": "string", "format": "uuid" }, "externalReference": { }, "quantity": { "maximum": 10000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "status": { "enum": [ "PENDING" ] }, "isReturnable": { "type": [ "null", "boolean" ] }, "sku": { }, "isPhysical": { "type": [ "null", "boolean" ] }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "weightUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightUnit" } ] }, "description": { }, "location": { }, "tariffNumber": { "maxLength": 32, "minLength": 6 }, "countryOfOrigin": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Country" } ] }, "vatPercentage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "unitPrice": { "maximum": 9999999, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "discountedUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "discountType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DiscountType" } ] }, "discountValue": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "meta": { "type": [ "null", "object" ] } } }, "UpdateOrderChannelAttributeDto": { "type": "object", "properties": { "value": { } } }, "UpdateOrderChannelDto": { "type": "object", "properties": { "name": { }, "integration": { }, "integrationReference": { }, "attributes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OrderChannelAttribute" } }, "isEnabled": { "type": "boolean" }, "isSendAutomatically": { "type": [ "null", "boolean" ] }, "isFulfillAutomatically": { "type": [ "null", "boolean" ] }, "pudoLimit": { "maximum": 20, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "UpdateOrderDto": { "required": [ "currency" ], "type": "object", "properties": { "visibleReference": { }, "status": { "enum": [ "PENDING", "DISPATCHED", "PARTLY_DISPATCHED", "CANCELLED", "ERROR", "MISSING_DELIVERY_OPTION" ] }, "isLocked": { "type": "boolean" }, "isReturn": { "type": "boolean" }, "currency": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Currency" } ] }, "tags": { "type": [ "null", "array" ] }, "meta": { "type": [ "null", "object" ] }, "addresses": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AddressDto" } }, "parcels": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UpdateParcelDto" } } } }, "UpdateParcelDto": { "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UpdateItemDto" } }, "orderId": { "type": "string", "format": "uuid" }, "description": { }, "isFulfilled": { "type": "boolean" }, "type": { "enum": [ "CARDBOARD" ] }, "weight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "weightUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightUnit" } ] }, "width": { "maximum": 10000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "height": { "maximum": 10000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "length": { "maximum": 10000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "float" }, "dimensionUnit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DimensionUnit" } ] }, "palletType": { "enum": [ "BOX", "EURO" ] }, "shipmentId": { }, "deliveryOption": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ParcelUpdateDeliveryOptionDto" } ] } } }, "UpdateSavedOrderFilterDto": { "type": "object", "properties": { "name": { }, "filters": { "type": [ "null", "object" ] } } }, "UpdateWebhookDto": { "type": "object", "properties": { "url": { }, "label": { }, "isActive": { "type": "boolean" }, "orderChannelIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "WebhookCreatedDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { }, "subject": { "enum": [ "ORDER_CREATED", "ORDER_UPDATED", "ORDER_DELETED", "SHIPMENT_CREATED" ] }, "label": { }, "isActive": { "type": "boolean" }, "signingSecret": { }, "orderChannelIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "createdAt": { "format": "date-time" }, "updatedAt": { "format": "date-time" } } }, "WebhookDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { }, "subject": { "enum": [ "ORDER_CREATED", "ORDER_UPDATED", "ORDER_DELETED", "SHIPMENT_CREATED" ] }, "label": { }, "isActive": { "type": "boolean" }, "orderChannelIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "createdAt": { "format": "date-time" }, "updatedAt": { "format": "date-time" } } }, "WebhookEventAttemptDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "attemptNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "httpStatus": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "responseBody": { }, "responseHeaders": { }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "createdAt": { "format": "date-time" } } }, "WebhookEventDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "webhookId": { "type": "string", "format": "uuid" }, "orderId": { "type": [ "null", "string" ], "format": "uuid" }, "subject": { "enum": [ "ORDER_CREATED", "ORDER_UPDATED", "ORDER_DELETED", "SHIPMENT_CREATED" ] }, "eventId": { }, "requestBody": { }, "requestHeaders": { }, "responseBody": { }, "responseHeaders": { }, "httpStatus": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "status": { "enum": [ "PENDING", "SUCCESS", "FAILED", "RETRYING" ] }, "attemptCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "attempts": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/WebhookEventAttemptDto" } }, "createdAt": { "format": "date-time" } } }, "WebhookSecretRotatedDto": { "type": "object", "properties": { "signingSecret": { } } }, "WeightUnit": { "enum": [ "G", "KG", "OZ", "LBS", null ] } } }, "tags": [ { "name": "Address" }, { "name": "Automations" }, { "name": "Comments" }, { "name": "Customers" }, { "name": "Default" }, { "name": "DeliveryOptionMappings" }, { "name": "DeliveryOptions" }, { "name": "Import" }, { "name": "Items" }, { "name": "Jobs" }, { "name": "OrderChannels" }, { "name": "Orders" }, { "name": "Parcels" }, { "name": "SavedOrderFilters" }, { "name": "Shipments" }, { "name": "Webhooks" }, { "name": "Shopify" }, { "name": "ShopifySetup" }, { "name": "WooCommerce" }, { "name": "WooCommerceSetup" } ] }