{ "schemes": ["https"], "swagger": "2.0", "info": { "description": "This is the API Gateway swagger maintained by Logistic developers.", "title": "API Gateway", "contact": {}, "version": "1.0" }, "host": "envios-api.olist.com", "basePath": "/v1", "paths": { "/": { "get": { "description": "search an integration using client_id and customer_id filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrations" ], "summary": "Search Integration", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "tray", "description": "Client ID", "name": "client_id", "in": "path", "required": true }, { "type": "string", "example": "123432", "description": "Reference", "name": "reference", "in": "path", "required": true } ], "responses": { "200": { "description": "Integration returned successfully", "schema": { "$ref": "#/definitions/integration.Integration" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/address/{postal_code}": { "get": { "description": "Resolves a Brazilian address by postal code using external providers with fallback strategy.\nPrimary source: ViaCEP. Fallback sources: BrasilAPI, DNE.", "produces": [ "application/json" ], "tags": [ "address" ], "summary": "Resolve address by postal code", "parameters": [ { "type": "string", "description": "Postal code (numbers only or formatted)", "name": "postal_code", "in": "path", "required": true } ], "responses": { "200": { "description": "Address resolved successfully", "schema": { "$ref": "#/definitions/dto.GatewayAddress" } }, "400": { "description": "Invalid postal code format", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Address not found in any provider", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "500": { "description": "Unexpected internal error", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/bagy/authorize-url": { "get": { "description": "Redirects to Bagy's OAuth authorize URL with required parameters", "produces": [ "application/json" ], "tags": [ "integrations" ], "summary": "Get Bagy authorize URL", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "loja.minhaloja.com.br", "description": "Bagy store domain (without scheme) example(loja.minhaloja.com.br)", "name": "host", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/integrations_features_create_integration.BagyAuthURLResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/batch-file-items/": { "get": { "description": "Retorna uma lista batch-file-items", "produces": [ "application/json" ], "tags": [ "batch-files" ], "summary": "Lista batch file items", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/financialdto.BatchFileItem" } } } } } }, "/batch-files/": { "get": { "description": "Retorna uma lista pagina de batch-files", "produces": [ "application/json" ], "tags": [ "batch-files" ], "summary": "Lista batch files", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/financialdto.BatchFile" } } } } } }, "/carriers": { "get": { "description": "Get all carriers available", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "carriers" ], "summary": "Get all carriers", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "Carriers returned successfully", "schema": { "$ref": "#/definitions/carriers_features_get_carrier.PagedCarriers" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/carriers/platforms-to-mapping": { "get": { "description": "Get mapping carriers vs integration ecommerce to serve ERP Client", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "carriers" ], "summary": "Get mapping carriers vs integration ecommerce", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "Mapping returned successfully", "schema": { "type": "array", "items": { "$ref": "#/definitions/carriers_features_get_carrier.PlatformToCarrierMapping" } } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/carriers/{slug}": { "get": { "description": "Get carrier by slug", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "carriers" ], "summary": "Get carrier", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "correios", "description": "Carrier slug", "name": "slug", "in": "path", "required": true } ], "responses": { "200": { "description": "Carrier returned successfully", "schema": { "$ref": "#/definitions/carriers_features_get_carrier.CarrierResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Carrier not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/coupon/": { "post": { "description": "Creates a new coupon for the affiliate platform. The coupon type comes from the payload.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "coupons-affiliate" ], "summary": "Creates a new affiliate coupon", "parameters": [ { "description": "Coupon payload", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/coupon_create.CreateCouponRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/coupon_create.CouponResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/coupon/metadata": { "get": { "description": "Get coupons metadata", "produces": [ "application/json" ], "tags": [ "coupons" ], "summary": "Retrieves a coupon metadata", "parameters": [ { "type": "string", "description": "Coupon Code", "name": "code", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.CouponMetadataResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/coupon/{code}": { "get": { "description": "Finds a coupon by the provided coupon code", "produces": [ "application/json" ], "tags": [ "coupons" ], "summary": "Retrieves a coupon by its code", "parameters": [ { "type": "string", "description": "Coupon Code", "name": "code", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.CouponPublicResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/coverage-zones/": { "get": { "description": "Returns a coverage zone by postal code.", "produces": [ "application/json" ], "tags": [ "coverage-zones" ], "summary": "Get coverage zone by postal code", "parameters": [ { "type": "string", "description": "Postal code to search coverage zone (CEP format)", "name": "postal_code", "in": "path", "required": true } ], "responses": { "200": { "description": "Coverage zone returned successfully", "schema": { "$ref": "#/definitions/dto.GatewayCoverageZone" } }, "400": { "description": "Invalid request (invalid postal_code)", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/customers": { "post": { "description": "Create customer using the user authorization token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "customers" ], "summary": "Create customer", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "description": "Customer payload", "name": "customer", "in": "body", "required": true, "schema": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.CustomerRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.CustomerResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/customers/": { "get": { "description": "Fetch customer using the user authorization token", "produces": [ "application/json" ], "tags": [ "customers" ], "summary": "Fetch customer", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.CustomerResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/customers/address": { "patch": { "description": "update customer address using the user authorization token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "customers" ], "summary": "update customer address", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Customer payload", "name": "address", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customer.Address" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/customers/contacts": { "patch": { "description": "update customer contact using the user authorization token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "customers" ], "summary": "update customer contact", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Customer payload (financial_email is optional; must be a valid email when provided)", "name": "contact", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customer.Contact" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/customers/document-number/{documentNumber}": { "get": { "description": "Fetch customer using the user authorization admin token", "produces": [ "application/json" ], "tags": [ "customers" ], "summary": "Fetch customer by document number", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.CustomerResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/customers/documents": { "patch": { "description": "Update customer documents using the user authorization token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "customers" ], "summary": "Update customer documents", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Customer payload", "name": "document", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers_features_update_documents.request" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/customers/packagings": { "post": { "description": "Create packaging using the user authorization token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "customers" ], "summary": "Create packaging", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "description": "Customer payload", "name": "customer", "in": "body", "required": true, "schema": { "$ref": "#/definitions/pack.Builder" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/pack.Pack" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } }, "patch": { "description": "Update customer packagings using the user authorization token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "customers" ], "summary": "Update customer packagings", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Packaging payload", "name": "document", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers_features_update_packagings.request" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/delivery-detail/receipt/download/{tracking_code}": { "get": { "description": "Download delivery detail receipt", "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "tags": [ "delivery-detail" ], "summary": "Download delivery detail receipt", "parameters": [ { "type": "string", "example": "AA123456789BR", "description": "Tracking code", "name": "tracking_code", "in": "path", "required": true } ], "responses": { "200": { "description": "Receipt file", "schema": { "type": "file" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Delivery detail or receipt not found" }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/devolutions/": { "get": { "description": "Returns devolution information based on the specified parameters.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "devolutions" ], "summary": "Get devolutions", "parameters": [ { "type": "string", "description": "devolution date (Format: YYYY-MM-DD)", "name": "devolution_at", "in": "query", "required": true }, { "type": "string", "description": "comma separated list of carrier slug(s)", "name": "carrier_slug__in", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/handlers.DevolutionResponse" } } } } } }, "/devolutions/finalize": { "post": { "description": "Finalize a list of devolutions and return a PDF document", "produces": [ "application/pdf" ], "tags": [ "devolutions" ], "summary": "Finalize devolution", "parameters": [ { "description": "devolutions to be finalized", "name": "devolutions", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/devolutiondomain.ExportDevolution" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/devolutions/operators/": { "get": { "description": "Returns a list of operators that bleeped on that date.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "devolutions" ], "summary": "Get operators by date", "parameters": [ { "type": "string", "description": "devolution date (Format: YYYY-MM-DD)", "name": "devolution_at", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.DevolutionOperatorResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/devolutions/pdf": { "post": { "description": "Generate a PDF document from a list of devolutions", "produces": [ "application/pdf" ], "tags": [ "devolutions" ], "summary": "Generate pdf", "parameters": [ { "description": "devolutions filter", "name": "devolutions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handlers.PDFParams" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/devolutions/xls": { "post": { "description": "Generate a XLS document from a list of devolutions", "produces": [ "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" ], "tags": [ "devolutions" ], "summary": "Generate xls", "parameters": [ { "description": "devolutions filter", "name": "devolutions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handlers.GetAndXLSQueryParams" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/devolutions/{tracking_code}/": { "get": { "description": "Returns devolution information based on the tracking code (normal or reverse).", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "devolutions" ], "summary": "Get devolution by tracking code", "parameters": [ { "type": "string", "example": "AA123456789BR", "description": "Tracking code", "name": "tracking_code", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.DevolutionByTrackingCodeResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/ecomm": { "post": { "description": "Create a New integration using the consented token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrations" ], "summary": "Create a New integration", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Integration payload", "name": "integration", "in": "body", "required": true, "schema": { "$ref": "#/definitions/integrations_features_create_integration.IntegrationRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/integrations_features_create_integration.IntegrationResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/freights": { "post": { "description": "Calculate freight quote for Olist Envios", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "freights" ], "summary": "Calculate freight quote", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Freight quote payload", "name": "quote", "in": "body", "required": true, "schema": { "$ref": "#/definitions/freights_features_freight_quote.QuoteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/freights_features_freight_quote.QuoteResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/freights/reverse/{shipmentId}": { "post": { "description": "Calculate freight reverse quote for Olist Envios", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "freights" ], "summary": "Calculate freight reverse quote", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Freight reverse quote payload", "name": "quote", "in": "body", "required": true, "schema": { "$ref": "#/definitions/freights_features_freight_quote.ReverseQuoteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/freights_features_freight_quote.QuoteResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/freights/shipments": { "post": { "description": "Calculate freight quote for devolution", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "freights" ], "summary": "Calculate freight quote for devolution", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Freight quote shipment payload", "name": "quote", "in": "body", "required": true, "schema": { "$ref": "#/definitions/freights_features_freight_quote.QuoteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/freights_features_freight_quote.QuoteResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/freights/simulate": { "post": { "description": "Calculate freight quote for Olist Envios", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "freights" ], "summary": "Calculate freight quote", "parameters": [ { "description": "Freight quote payload", "name": "quote", "in": "body", "required": true, "schema": { "$ref": "#/definitions/freights_features_freight_quote.QuoteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/freights_features_freight_quote.QuoteResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/hubs": { "get": { "description": "Retorna uma lista de hubs com status ativo", "produces": [ "application/json" ], "tags": [ "hubs" ], "summary": "Lista hubs ativos", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/hubdomain.Hub" } } } } } }, "/hubs/zipcode/:{zipcode}": { "get": { "description": "Retorna um hub com status ativo dado um codigo de cep", "produces": [ "application/json" ], "tags": [ "hubs" ], "summary": "Retorna um hub com status ativo dado um codigo de cep", "parameters": [ { "type": "string", "description": "Codigo de cep", "name": "zipcode", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.HubWithCollectDays" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/integrations": { "post": { "description": "Set up integration using the consented token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "integrations" ], "summary": "Set up integration", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Integration payload", "name": "integration", "in": "body", "required": true, "schema": { "$ref": "#/definitions/integrations_features_create_integration.IntegrationRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/integrations_features_create_integration.IntegrationResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/issues/onboarding": { "get": { "description": "Search onboarding issues", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "issues" ], "summary": "Search onboarding issues", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "Onboarding issues returned successfully", "schema": { "type": "array", "items": { "$ref": "#/definitions/iofeature.PublicIssue" } } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/issues/operation-changing": { "get": { "description": "Retrieve the open operation changing issue for the authenticated customer", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "issues" ], "summary": "Get Operation Changing Issue", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "Operation changing issue returned successfully", "schema": { "$ref": "#/definitions/iofeature.PublicIssue" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Issue not found" }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/issues/shipment/{id}/handle": { "post": { "description": "Handle for and issue", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "issues" ], "summary": "Handle for and issue", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "description": "Shipment Issue Handle payload", "name": "quote", "in": "body", "required": true, "schema": { "$ref": "#/definitions/issues_devolution.ShipmentIssueHandleInput" } } ], "responses": { "200": { "description": "Issue pos handle returned successfully", "schema": { "$ref": "#/definitions/iofeature.PublicIssue" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/issues/volume": { "get": { "description": "Search issues with yours volumes", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "issues" ], "summary": "Search for and issue and yours volumes", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "integer", "example": 2, "description": "Page number", "name": "page", "in": "query" }, { "type": "string", "example": "-created_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "Volume with issue id returned successfully", "schema": { "$ref": "#/definitions/pagination.PageResult-iofeature_GatewayIssueVolumeOutput" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/issues/{id}/shipping-details": { "get": { "description": "Search issues with yours volumes", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "issues" ], "summary": "Search for and issue and yours volumes", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "Volume with issue id returned successfully", "schema": { "$ref": "#/definitions/iofeature.GatewayIssueShippingDetailOutput" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/labels/:integration_id/pdf/:invoice_key/": { "get": { "description": "Print PDF label by invoice key", "consumes": [ "application/json" ], "produces": [ "application/pdf" ], "tags": [ "labels" ], "summary": "Print PDF label", "parameters": [ { "type": "string", "description": "Integration id", "name": "integration_id", "in": "path", "required": true }, { "type": "string", "description": "Invoice key", "name": "invoice_key", "in": "path", "required": true } ], "responses": { "200": { "description": "Labels generated successfully" }, "204": { "description": "Without labels, because don't exist or are cancelled" }, "206": { "description": "Labels generated partially, because some labels don't exist or are cancelled" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/labels/:integration_id/zpl/:invoice_key/": { "get": { "description": "Print ZPL label by invoice key", "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "tags": [ "labels" ], "summary": "Print ZPL label", "parameters": [ { "type": "string", "description": "Integration id", "name": "integration_id", "in": "path", "required": true }, { "type": "string", "description": "Invoice key", "name": "invoice_key", "in": "path", "required": true } ], "responses": { "200": { "description": "Labels generated successfully" }, "204": { "description": "Without labels, because don't exist or are cancelled" }, "206": { "description": "Labels generated partially, because some labels don't exist or are cancelled" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/labels/pdf": { "post": { "description": "Print ZPL label of the filtered shipments", "consumes": [ "application/json" ], "produces": [ "application/pdf" ], "tags": [ "labels" ], "summary": "Print PDF label", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header" }, { "description": "Label payload", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/printlabel.LabelRequest" } } ], "responses": { "200": { "description": "Labels generated successfully" }, "204": { "description": "Without labels, because don't exist or are cancelled" }, "206": { "description": "Labels generated partially, because some labels don't exist or are cancelled" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/labels/zpl": { "post": { "description": "Print ZPL label of the filtered shipments", "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "tags": [ "labels" ], "summary": "Print ZPL label", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header" }, { "description": "Label payload", "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/printlabel.LabelRequest" } } ], "responses": { "200": { "description": "Labels generated successfully" }, "204": { "description": "Without labels, because don't exist or are cancelled" }, "206": { "description": "Labels generated partially, because some labels don't exist or are cancelled" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments": { "get": { "description": "Search shipment by query params", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Search for a shipment", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "ORD123", "description": "Shipment reference", "name": "reference", "in": "query" }, { "type": "integer", "example": 2, "description": "Page number", "name": "page", "in": "query" }, { "type": "integer", "example": 10, "description": "Quantity of items on each page", "name": "limit", "in": "query" }, { "type": "string", "example": "-created_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "Shipments returned successfully", "schema": { "$ref": "#/definitions/pagination.PageResult-shipments_list_GatewayShipmentResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } }, "post": { "description": "Create a shipment to be delivered", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Create shipment", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Shipment payload", "name": "quote", "in": "body", "required": true, "schema": { "$ref": "#/definitions/iofeature.GatewayShipmentPayload" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/iofeature.GatewayShipmentResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "402": { "description": "Insufficient credit", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/:id/reverse": { "post": { "description": "Create a reverse shipment to be delivered", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Create reverse shipment", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Shipment payload", "name": "quote", "in": "body", "required": true, "schema": { "$ref": "#/definitions/shipments_reverse.CreateReverseShipmentRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/dto.GatewayShipmentResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "402": { "description": "Insufficient credit", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/cart-item": { "post": { "description": "Save Cart Shipping Item", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Save Cart Shipping Item", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "description": "Cart Shipping Item payload", "name": "quote", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.GatewayShipmentPayload" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/shipments_cart.CartItemResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "402": { "description": "Insufficient credit", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/cart-item/:reference": { "delete": { "description": "Remove Cart Shipping Item", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Remove Cart Shipping Item", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "402": { "description": "Insufficient credit", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/cart-item/:reference/hire": { "post": { "description": "Hire Shipment by Cart Shipping Item", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Hire Shipment by Cart Shipping Item", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/dto.GatewayShipmentResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "402": { "description": "Insufficient credit", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/hub-receipt": { "post": { "description": "Create a devolution or resend hire from hub", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Handle hub receipts, router between devolution and resend hire", "parameters": [ { "description": "Shipment devolution payload", "name": "quote", "in": "body", "required": true, "schema": { "$ref": "#/definitions/iofeature.GatewayHubReceiptInput" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/iofeature.GatewayHubReceiptOutput" } }, "203": { "description": "Non-Authoritative Information", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Volume not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/invoice/carrier/": { "post": { "description": "Returns a list of carrier slugs associated with the provided invoice_keys", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Get carriers by invoice keys", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Invoice keys payload", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/shipments_list.InvoiceUsageRequest" } } ], "responses": { "200": { "description": "Carriers returned successfully", "schema": { "$ref": "#/definitions/shipmentdomain.InvoiceAndCarriers" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/shipping-cart": { "get": { "description": "Get Cart Shipping", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Get Cart Shipping", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/shipments_cart.CartResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "402": { "description": "Insufficient credit", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/trackings/{shipment_code}": { "get": { "description": "Get a shipment tracking by shipment_code", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Get shipment tracking", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "SHIP123456", "description": "Shipment Code", "name": "shipment_code", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/iofeature.GatewayTrackingResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Shipment not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/{id}": { "get": { "description": "Get a shipment by id", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Get shipment", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "0d35144f-529c-4626-bbe4-6a440afcb629", "description": "Shipment UUID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/iofeature.GatewayShipmentResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Shipment not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shipments/{id}/cancel": { "post": { "description": "Cancel a shipment to be delivered", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "shipments" ], "summary": "Cancel shipment", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "0d35144f-529c-4626-bbe4-6a440afcb629", "description": "Shipment UUID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Shipment not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/shopify/authorize-url": { "get": { "description": "Get shopify authenticate URL", "produces": [ "application/json" ], "tags": [ "integrations" ], "summary": "Get shopify authenticate URL", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "Shop URL", "name": "shop", "in": "query", "required": true }, { "type": "string", "description": "Host", "name": "host", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/integrations_features_create_integration.ShopifyAuthURLResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/standalone/signup": { "post": { "description": "Creates a customer account in the standalone sign-up flow after validating CNPJ, email and address.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "standalone" ], "summary": "Create standalone account", "parameters": [ { "description": "Sign-up payload", "name": "sign-up", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.SignUpRequest" } } ], "responses": { "201": { "description": "Created customer", "schema": { "$ref": "#/definitions/dto.SignUpResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "403": { "description": "CNPJ already registered with Envios", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Postal code out of scope or coupon not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "409": { "description": "CNPJ/email already registered, ERP product active or coupon already used", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/standalone/validate": { "post": { "description": "Validates document number (CNPJ), postal code and email for the standalone sign-up flow.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "standalone" ], "summary": "Validate standalone sign-up data", "parameters": [ { "description": "Validation payload", "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.ValidateRequest" } } ], "responses": { "200": { "description": "Validation output with hub or nearest PUDO", "schema": { "$ref": "#/definitions/dto.ValidateResponse" } }, "204": { "description": "No content when only document/email is validated", "schema": { "type": "string" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "403": { "description": "CNPJ already registered with Envios", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Postal code out of scope", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "409": { "description": "CNPJ/email already registered or CNPJ has ERP product", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/sticky/": { "get": { "description": "Get sticky information, optionally considering nearby PUDOs based on radius and limit filters.", "produces": [ "application/json" ], "tags": [ "sticky" ], "summary": "Get sticky information", "parameters": [ { "type": "number", "description": "Radius in kilometers for nearby PUDOs (default 30km, must be \u003e 0 when informed)", "name": "pudo_radius", "in": "query" }, { "type": "integer", "description": "Maximum number of PUDOs to consider (0 means no limit)", "name": "pudo_limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/stickydomain.Sticky" } }, "400": { "description": "Invalid request (invalid pudo_radius or pudo_limit)", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/subscriptions/guaranteed-refund/": { "get": { "description": "Lists the authenticated customer subscriptions, optionally filtered by active status.", "produces": [ "application/json" ], "tags": [ "subscriptions" ], "summary": "List guaranteed refund subscriptions", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "boolean", "example": true, "description": "Active status filter", "name": "active", "in": "query" }, { "type": "integer", "example": 2, "description": "Page number", "name": "page", "in": "query" }, { "type": "integer", "example": 50, "description": "Page size", "name": "limit", "in": "query" }, { "type": "string", "example": "-subscribed_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "Subscriptions returned successfully", "schema": { "$ref": "#/definitions/pagination.PageResult-subscriptions_guaranteed_refund_SubscriptionResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/subscriptions/guaranteed-refund/{subscription_id}/unsubscribe/": { "post": { "description": "Registers the customer opt-out, filling unsubscribed_at. The subscription is referenced only by its ID.", "produces": [ "application/json" ], "tags": [ "subscriptions" ], "summary": "Unsubscribe from a subscription", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "0d35144f-529c-4626-bbe4-6a440afcb629", "description": "Subscription ID", "name": "subscription_id", "in": "path", "required": true } ], "responses": { "200": { "description": "Subscription cancelled successfully", "schema": { "$ref": "#/definitions/subscriptions_guaranteed_refund.SubscriptionResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Subscription not found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/tms": { "get": { "description": "List TMS rules", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "tms" ], "summary": "List TMS rules", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "integer", "example": 2, "description": "Page number", "name": "page", "in": "query" }, { "type": "integer", "example": 10, "description": "Quantity of items on each page", "name": "limit", "in": "query" }, { "type": "string", "example": "-created_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "TMS rules returned successfully", "schema": { "$ref": "#/definitions/pagination.PageResult-gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_tms_features_TMSRuleResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } }, "post": { "description": "Create TMS rule using the user authorization token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "tms" ], "summary": "Create TMS rule", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "TMS rule payload", "name": "rule", "in": "body", "required": true, "schema": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_tms_features.TMSRuleRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_tms_features.TMSRuleResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/tms/{id}": { "delete": { "description": "Delete TMS rule using the user authorization token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "tms" ], "summary": "Delete TMS rule", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Rule id", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } }, "patch": { "description": "Update TMS rule using the user authorization token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "tms" ], "summary": "Update TMS rule", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Rule id", "name": "id", "in": "path", "required": true }, { "description": "TMS rule payload", "name": "rule", "in": "body", "required": true, "schema": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_tms_features.TMSRuleRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_tms_features.TMSRuleResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "422": { "description": "Payload validation failed", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/trackings/{code}": { "get": { "description": "Get trackings by code", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "trackings" ], "summary": "Get trackings", "parameters": [ { "type": "string", "example": "AA123456789BR", "description": "Tracking code", "name": "tracking_code", "in": "path", "required": true } ], "responses": { "200": { "description": "Trackings returned successfully", "schema": { "type": "array", "items": { "$ref": "#/definitions/tracking.Tracking" } } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Tracking not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/trackings/{tracking_code}": { "get": { "description": "Get volumes and trackings by tracking code", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "volumes" ], "summary": "Get volumes and trackings by tracking code", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "AA123456789BR", "description": "Tracking code", "name": "tracking_code", "in": "path", "required": true } ], "responses": { "200": { "description": "Trackings returned successfully", "schema": { "type": "array", "items": { "$ref": "#/definitions/trackingfeature.GatewayTracking" } } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Tracking not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/transactions": { "get": { "description": "Search transactions by query params", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "transactions" ], "summary": "Search for transactions", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "credit", "description": "Transaction type", "name": "type", "in": "query" }, { "type": "integer", "example": 2, "description": "The current page", "name": "page", "in": "query" }, { "type": "integer", "example": 10, "description": "The quantity of items on each page", "name": "limit", "in": "query" }, { "type": "string", "example": "-created_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "Transactions returned successfully", "schema": { "$ref": "#/definitions/handlers.PagedTransactions" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/transactions/bankslip/extract": { "get": { "description": "Get wallet bank slip transactions in CSV format", "produces": [ "text/csv" ], "tags": [ "wallets" ], "summary": "Get wallet bank slip transactions", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "2026-03-31", "description": "Start date", "name": "created_at__gte", "in": "path", "required": true }, { "type": "string", "example": "2026-03-31", "description": "End date", "name": "created_at__lte", "in": "path", "required": true } ], "responses": { "200": { "description": "CSV file with bank slip transactions", "schema": { "type": "string" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/transactions/compositions/": { "get": { "description": "Search transactions by query params", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "transactions" ], "summary": "Search for transactions compositions", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Volume id", "name": "volume_id", "in": "query" }, { "type": "string", "example": "indemnity", "description": "Transaction type", "name": "transaction_type", "in": "query" } ], "responses": { "200": { "description": "Transactions compositions returned successfully", "schema": { "type": "array", "items": { "$ref": "#/definitions/handlers.Composition" } } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/transactions/{id}": { "get": { "description": "Get transaction by id", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "transactions" ], "summary": "Get for transactions", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "integer", "example": 345, "description": "Transaction id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "Transactions returned successfully", "schema": { "$ref": "#/definitions/transactionfeature.TransactionDetailResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/tray/authorize-url": { "get": { "description": "Redirects to Tray's OAuth authorize URL with required parameters", "produces": [ "text/plain" ], "tags": [ "integrations" ], "summary": "Get tray authorize URL", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "loja.minhaloja.com.br", "description": "Tray store domain (without scheme) example(loja.minhaloja.com.br)", "name": "host", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/integrations_features_create_integration.TrayAuthURLResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/volumes": { "get": { "description": "Search volume by query params", "produces": [ "application/json" ], "tags": [ "volumes" ], "summary": "Search for a volume", "parameters": [ { "type": "string", "example": "123456789", "description": "Volume reference", "name": "reference", "in": "query" }, { "type": "integer", "example": 2, "description": "The current page", "name": "page", "in": "query" }, { "type": "integer", "example": 10, "description": "The quantity of items on each page", "name": "limit", "in": "query" }, { "type": "string", "example": "-created_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "Volumes returned successfully", "schema": { "$ref": "#/definitions/handlers.PagedVolumes" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/volumes/filter-v2/{status_group}": { "get": { "description": "List volumes filter by status group", "produces": [ "application/json" ], "tags": [ "volumes" ], "summary": "List volumes filter by status group", "parameters": [ { "type": "string", "example": "awaiting_send", "description": "Status group", "name": "status_group", "in": "path", "required": true }, { "type": "integer", "example": 2, "description": "The current page", "name": "page", "in": "query" }, { "type": "integer", "example": 10, "description": "The quantity of items on each page", "name": "limit", "in": "query" }, { "type": "string", "example": "-created_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "Volumes returned successfully", "schema": { "$ref": "#/definitions/handlers.PagedVolumes" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/volumes/filter/{status_group}": { "get": { "description": "List volumes by status group", "produces": [ "application/json" ], "tags": [ "volumes" ], "summary": "List volumes by status group", "parameters": [ { "type": "string", "example": "awaiting_collect, sent, delayed, delivered, not_delivered", "description": "Status group", "name": "status_group", "in": "path", "required": true }, { "type": "integer", "example": 2, "description": "The current page", "name": "page", "in": "query" }, { "type": "integer", "example": 10, "description": "The quantity of items on each page", "name": "limit", "in": "query" }, { "type": "string", "example": "-created_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "Volumes returned successfully", "schema": { "$ref": "#/definitions/handlers.PagedVolumes" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/volumes/search-v2": { "get": { "description": "Search volumes by receiver name, document, postal code or tracking code, returning the enriched PublicVolumeResponse shape. Only one search filter is allowed per request.", "produces": [ "application/json" ], "tags": [ "volumes" ], "summary": "Search for volumes (v2)", "parameters": [ { "type": "string", "example": "Tiago", "description": "Receiver name", "name": "receiver_name", "in": "query" }, { "type": "string", "example": "12345678909", "description": "Receiver CPF or CNPJ (formatted or unformatted)", "name": "receiver_document", "in": "query" }, { "type": "string", "example": "01310100", "description": "Receiver postal code (formatted or unformatted)", "name": "receiver_postal_code", "in": "query" }, { "type": "string", "example": "AA123456789BR", "description": "Tracking code", "name": "tracking_code", "in": "query" }, { "type": "integer", "example": 2, "description": "The current page", "name": "page", "in": "query" }, { "type": "integer", "example": 10, "description": "The quantity of items on each page", "name": "limit", "in": "query" }, { "type": "string", "example": "-created_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "Volumes returned successfully", "schema": { "$ref": "#/definitions/handlers.PagedVolumes" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/volumes/statistics": { "get": { "description": "Get volumes statistics", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "volumes" ], "summary": "Get volumes statistics", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true } ], "responses": { "200": { "description": "Statistics returned successfully", "schema": { "$ref": "#/definitions/iofeature.GatewayStatisticsResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/volumes/statistics-v2": { "get": { "description": "Get volumes statistics v2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "volumes" ], "summary": "Get volumes statistics v2", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true } ], "responses": { "200": { "description": "Statistics returned successfully", "schema": { "$ref": "#/definitions/iofeature.GatewayStatisticsV2Response" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/volumes/{id}/cancel": { "post": { "description": "Cancel a volume to be delivered", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "volumes" ], "summary": "Cancel a volume", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "type": "string", "example": "0d35144f-529c-4626-bbe4-6a440afcb629", "description": "Volume UUID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Volume not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/volumes/{id}/cancel-without-refund/": { "post": { "description": "Cancel a volume without refund", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "volumes" ], "summary": "Cancel a volume without refund", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "0d35144f-529c-4626-bbe4-6a440afcb629", "description": "Volume UUID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "404": { "description": "Volume not found", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/wallets/": { "get": { "description": "Get wallet information", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Get wallet information", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.WalletResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/wallets/billing/prepaid": { "post": { "description": "This endpoint provides metadata required for the frontend to build the deposit screen for the correct user.", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Request deposit NewHandler", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Billing configure payload", "name": "deposit", "in": "body", "required": true, "schema": { "$ref": "#/definitions/walletdomain.BillingAttributePrepaid" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/wallets_billing.ConfigurePrepaidResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/wallets/deposit": { "post": { "description": "Request deposit in wallet", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Request deposit", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Deposit payload", "name": "deposit", "in": "body", "required": true, "schema": { "$ref": "#/definitions/wallets_deposit.DepositRequestData" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/wallets_deposit.DepositResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/wallets/deposit/:financial_req_id/recreate/": { "post": { "description": "Request deposit recreate in wallet", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Request deposit Recreate", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true }, { "description": "Recreate payload", "name": "deposit", "in": "body", "required": true, "schema": { "$ref": "#/definitions/wallets_deposit.RecreateRequestData" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/wallets/deposit/metadata": { "get": { "description": "This endpoint provides metadata required for the frontend to build the deposit screen for the correct user.", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Request deposit NewHandler", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Customer id", "name": "X-Customer-Id", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/wallets_deposit.DepositMetadataResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/wallets/deposit/{:financial_req_id}": { "get": { "description": "Get deposit information", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Get deposit", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DepositResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/wallets/financial-requests/": { "get": { "description": "Search financial requests by query params", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Search for financial requests", "parameters": [ { "type": "integer", "example": 2, "description": "The current page", "name": "page", "in": "query" }, { "type": "integer", "example": 10, "description": "The quantity of items on each page", "name": "limit", "in": "query" }, { "type": "string", "example": "-created_at", "description": "Pagination ordering", "name": "ordering", "in": "query" } ], "responses": { "200": { "description": "Financial requests returned successfully", "schema": { "$ref": "#/definitions/pagination.PageResult-handlers_FinancialRequestResponse" } }, "400": { "description": "Invalid request", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/wallets/financial-requests/{financial_req_id}/bank-slip/pdf": { "get": { "description": "Returns the bank slip (boleto) PDF for a financial request", "produces": [ "application/pdf" ], "tags": [ "wallets" ], "summary": "Get bank slip pdf", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "example": "0d35144f-529c-4626-bbe4-6a440afcb629", "description": "Financial request id", "name": "financial_req_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/wallets/postpaid/status/": { "get": { "description": "Returns the current postpaid billing status for the authenticated customer. \\", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Get postpaid wallet status", "responses": { "200": { "description": "Postpaid status returned successfully", "schema": { "$ref": "#/definitions/handlers.PostpaidStatusResponse" } }, "401": { "description": "Invalid token", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "403": { "description": "Wallet is not postpaid", "schema": { "$ref": "#/definitions/standerr.StandardError" } }, "500": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/standerr.StandardError" } } } } }, "/wallets/withdraw": { "post": { "description": "Request withdraw in wallet", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Request withdraw", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "description": "Withdraw payload", "name": "deposit", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handlers.WithdrawalRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.RequestWithdrawResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/wallets/withdraw/configs": { "post": { "description": "Get withdraw configs", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Get withdraw configs", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handlers.WithdrawalConfig" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } }, "/wallets/withdraw/{:financial_req_id}/process/": { "post": { "description": "Process withdraw in wallet", "produces": [ "application/json" ], "tags": [ "wallets" ], "summary": "Process withdraw", "parameters": [ { "type": "string", "example": "Bearer token", "description": "Authorization token", "name": "Authorization", "in": "header", "required": true }, { "description": "Withdraw payload", "name": "deposit", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handlers.ProcessWithdrawRequest" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/echo.HTTPError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/echo.HTTPError" } } } } } }, "definitions": { "carriers_features_get_carrier.CarrierMap": { "type": "object", "properties": { "carrier_slug": { "type": "string", "example": "correios-sedex" }, "platform_code": { "type": "string", "example": "Olist Envios Correios SEDEX" } } }, "carriers_features_get_carrier.CarrierResponse": { "type": "object", "properties": { "active": { "type": "boolean" }, "address": { "type": "string" }, "document_number": { "type": "string" }, "ie": { "type": "string" }, "name": { "type": "string" }, "shipping_method": { "type": "string" }, "slug": { "type": "string" } } }, "carriers_features_get_carrier.PagedCarriers": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/carriers_features_get_carrier.CarrierResponse" } }, "total": { "type": "integer" } } }, "carriers_features_get_carrier.PlatformToCarrierMapping": { "type": "object", "properties": { "carriers": { "type": "array", "items": { "$ref": "#/definitions/carriers_features_get_carrier.CarrierMap" } }, "id": { "type": "string", "example": "13" }, "platform": { "type": "string", "enum": [ "tray", "nuvemshop", "yampi", "vnda", "shopify" ], "example": "tray" } } }, "collections.Availabilities": { "type": "object", "properties": { "friday": { "type": "boolean" }, "id": { "type": "string" }, "monday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "seller_id": { "type": "string" }, "sunday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" } } }, "collections.Collection": { "type": "object", "properties": { "collected_at": { "type": "string" }, "collected_packages_count": { "type": "integer" }, "created_at": { "type": "string" }, "driver_license_plate": { "type": "string" }, "driver_name": { "type": "string" }, "driver_observations": { "type": "array", "items": { "type": "string" } }, "driver_phone": { "type": "string" }, "execution_date": { "type": "string" }, "id": { "type": "string" }, "package_stats": { "$ref": "#/definitions/collections.PackageStats" }, "queue_position": { "type": "integer" }, "receipt_code": { "type": "string" }, "seller_code": { "type": "string" }, "status": { "type": "string" } } }, "collections.PackageStats": { "type": "object", "properties": { "canceled": { "type": "integer" }, "collected": { "type": "integer" }, "collected_out_of_spot": { "type": "integer" }, "lost": { "type": "integer" }, "moved": { "type": "integer" }, "not_bleeped": { "type": "integer" }, "not_packed": { "type": "integer" }, "pending": { "type": "integer" }, "received": { "type": "integer" } } }, "coupon.Type": { "type": "string", "enum": [ "affiliate", "partner", "commercial", "m2m" ], "x-enum-varnames": [ "CouponTypeAffiliate", "CouponTypePartner", "CouponTypeCommercial", "CouponM2M" ] }, "coupon_create.CouponResponse": { "type": "object", "properties": { "benefits_customer_bonus_value": { "$ref": "#/definitions/money.Money" }, "code": { "type": "string" }, "expiration_at": { "type": "string" }, "responsible": { "type": "string" }, "reward_description": { "type": "string" }, "type": { "type": "string" } } }, "coupon_create.CreateCouponRequest": { "type": "object", "properties": { "code": { "type": "string" }, "customer_bonus_value": { "$ref": "#/definitions/money.Money" }, "expiration_at": { "type": "string" }, "responsible": { "type": "string" }, "reward_description": { "type": "string" }, "type": { "$ref": "#/definitions/coupon.Type" } } }, "customer.Address": { "type": "object", "required": [ "city", "neighborhood", "number", "postal_code", "state", "street" ], "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "latitude": { "$ref": "#/definitions/null.Float" }, "longitude": { "$ref": "#/definitions/null.Float" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "postal_code": { "type": "integer" }, "reference": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } } }, "customer.Contact": { "type": "object", "required": [ "email", "name", "phone" ], "properties": { "email": { "type": "string" }, "financial_email": { "$ref": "#/definitions/null.String" }, "name": { "type": "string" }, "phone": { "type": "string" } } }, "customer.Customer": { "type": "object", "properties": { "address": { "$ref": "#/definitions/customer.Address" }, "contact": { "$ref": "#/definitions/customer.Contact" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "created_from": { "type": "string" }, "document_number": { "type": "string" }, "flat_fee": { "$ref": "#/definitions/money.Money" }, "id": { "type": "string" }, "ie": { "type": "string" }, "markup": { "type": "number" }, "name": { "type": "string" }, "operation_slug": { "$ref": "#/definitions/operation.OperationSlug" }, "packagings": { "type": "array", "items": { "$ref": "#/definitions/pack.Pack" } }, "pricing_created_at": { "type": "string" }, "settings": { "$ref": "#/definitions/customer.Settings" }, "subscription_id": { "type": "string" }, "trade_name": { "type": "string" }, "updated_at": { "type": "string" }, "wallet_id": { "type": "string" } } }, "customer.Settings": { "type": "object", "properties": { "is_markup_scripted": { "type": "boolean" } } }, "customers_features_update_documents.request": { "type": "object", "properties": { "name": { "$ref": "#/definitions/null.String" }, "trade_name": { "$ref": "#/definitions/null.String" } } }, "customers_features_update_packagings.request": { "type": "object", "properties": { "customer_id": { "type": "string" }, "height": { "$ref": "#/definitions/units.Length" }, "id": { "type": "string" }, "length": { "$ref": "#/definitions/units.Length" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "devolutiondomain.ExportDevolution": { "type": "object", "required": [ "carrier_slug", "devolution_at", "operator", "volumes" ], "properties": { "carrier_slug": { "type": "string" }, "devolution_at": { "type": "string", "example": "2025-03-31" }, "operator": { "type": "string" }, "volumes": { "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/devolutiondomain.ExportVolume" } } } }, "devolutiondomain.ExportVolume": { "type": "object", "required": [ "carrier_slug", "devolution_carrier_slug", "devolution_tracking_code", "tracking_code" ], "properties": { "carrier_slug": { "type": "string" }, "devolution_carrier_slug": { "type": "string" }, "devolution_tracking_code": { "type": "string" }, "hub_name": { "type": "string" }, "tracking_code": { "type": "string" } } }, "dto.Agent": { "type": "object", "required": [ "city", "document_number", "name", "neighborhood", "number", "postal_code", "state", "street" ], "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "document_number": { "type": "string" }, "email": { "type": "string" }, "ie": { "type": "string" }, "name": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "phone": { "type": "string" }, "postal_code": { "type": "integer" }, "reference": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } } }, "dto.DepositResponse": { "type": "object", "properties": { "amount": { "$ref": "#/definitions/money.Money" }, "event_timestamp": { "type": "string" }, "id": { "type": "string" }, "payment_banking_data": {}, "payment_method": { "$ref": "#/definitions/walletdomain.PaymentMethod" }, "status": { "$ref": "#/definitions/walletdomain.FinancialStatus" }, "transaction_type": { "$ref": "#/definitions/walletdomain.TransactionType" } } }, "dto.GatewayAddress": { "type": "object", "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "ibge": { "type": "string" }, "neighborhood": { "type": "string" }, "postal_code": { "type": "integer" }, "state": { "type": "string" }, "street": { "type": "string" } } }, "dto.GatewayCoverageZone": { "type": "object", "properties": { "hub": { "$ref": "#/definitions/dto.GatewayHubWithCollectDays" }, "pudos": { "$ref": "#/definitions/pudo.NearestPudo" } } }, "dto.GatewayHubWithCollectDays": { "type": "object", "properties": { "address": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "collect_days": { "type": "array", "items": { "type": "string" } }, "collection_frequency": { "type": "string" }, "complement": { "type": "string" }, "country": { "type": "string" }, "created_at": { "type": "string" }, "document_number": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "region": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string" }, "store_name": { "type": "string" }, "zip_code": { "type": "string", "example": "0" } } }, "dto.GatewayProductPayload": { "type": "object", "required": [ "height", "length", "quantity", "weight", "width" ], "properties": { "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "quantity": { "type": "integer" }, "unit_value": { "$ref": "#/definitions/money.Money" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "dto.GatewayShipmentPayload": { "type": "object", "required": [ "carrier_slug", "invoice", "receiver" ], "properties": { "carrier_slug": { "type": "string" }, "invoice": { "$ref": "#/definitions/dto.Invoice" }, "products": { "type": "array", "items": { "$ref": "#/definitions/dto.GatewayProductPayload" } }, "receiver": { "$ref": "#/definitions/dto.Agent" }, "reference": { "type": "string" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/dto.GatewayVolumePayload" } } } }, "dto.GatewayShipmentResponse": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "integration_id": { "type": "string" }, "integration_name": { "type": "string" }, "invoice": { "$ref": "#/definitions/dto.Invoice" }, "receiver": { "$ref": "#/definitions/dto.Agent" }, "reference": { "type": "string" }, "sender": { "$ref": "#/definitions/dto.Agent" }, "shipment_code": { "$ref": "#/definitions/null.String" }, "shipment_status": { "type": "string" }, "shipment_tracking_url": { "type": "string" }, "shipping_limit_time": { "$ref": "#/definitions/null.String" }, "total_freight_value": { "$ref": "#/definitions/money.Money" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/dto.GatewayVolumeResponse" } } } }, "dto.GatewayVolumePayload": { "type": "object", "required": [ "height", "length", "weight", "width" ], "properties": { "declared_value": { "$ref": "#/definitions/money.Money" }, "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "reference": { "type": "string" }, "type": { "type": "string", "default": "box" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "dto.GatewayVolumeResponse": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "created_at": { "type": "string" }, "declared_value": { "$ref": "#/definitions/money.Money" }, "freight_value": { "$ref": "#/definitions/money.Money" }, "height": { "$ref": "#/definitions/units.Length" }, "id": { "type": "string" }, "length": { "$ref": "#/definitions/units.Length" }, "parent_id": { "$ref": "#/definitions/uuid.NullUUID" }, "reference": { "type": "string" }, "shipment_id": { "type": "string" }, "status": { "type": "string" }, "tracking_code": { "type": "string" }, "tracking_url": { "type": "string" }, "type": { "type": "string", "default": "box" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "dto.Invoice": { "type": "object", "properties": { "cfop": { "type": "integer" }, "ie": { "type": "string" }, "issue_date": { "type": "string" }, "key": { "type": "string" }, "number": { "type": "integer" }, "serial_number": { "type": "integer" } } }, "dto.LogisticAddress": { "type": "object", "required": [ "city", "neighborhood", "number", "postal_code", "state", "street" ], "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "postal_code": { "type": "integer" }, "reference": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } } }, "dto.LogisticContact": { "type": "object", "required": [ "email", "name", "phone" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" } } }, "dto.RechargeIssueResponse": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "reason": { "type": "string" } } }, "dto.ShippingQuoteResponse": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "custom_delivery_time": { "type": "integer" }, "custom_total_cost": { "$ref": "#/definitions/money.Money" }, "delivery_time": { "type": "integer" }, "display_name": { "type": "string" }, "shipping_method": { "type": "string" }, "total_cost": { "$ref": "#/definitions/money.Money" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/dto.VolumeResponse" } } } }, "dto.SignUpRequest": { "type": "object", "required": [ "document_number", "logistic_address", "logistic_contact", "name", "trade_name", "user" ], "properties": { "code": { "type": "string" }, "document_number": { "type": "string" }, "ie": { "type": "string", "default": "ISENTO" }, "logistic_address": { "$ref": "#/definitions/dto.LogisticAddress" }, "logistic_contact": { "$ref": "#/definitions/dto.LogisticContact" }, "name": { "type": "string" }, "trade_name": { "type": "string" }, "user": { "$ref": "#/definitions/dto.UserRequest" } } }, "dto.SignUpResponse": { "type": "object", "properties": { "document_number": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "trade_name": { "type": "string" } } }, "dto.UserRequest": { "type": "object", "required": [ "email", "name", "password", "phone" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "phone": { "type": "string" } } }, "dto.ValidateRequest": { "type": "object", "properties": { "document_number": { "$ref": "#/definitions/null.String" }, "email": { "$ref": "#/definitions/null.String" }, "postal_code": { "$ref": "#/definitions/null.String" } } }, "dto.ValidateResponse": { "type": "object", "properties": { "hub": { "$ref": "#/definitions/hubdomain.Hub" }, "operation_slug": { "$ref": "#/definitions/operation.OperationSlug" }, "pudos": { "$ref": "#/definitions/pudo.NearestPudo" } } }, "dto.VolumeResponse": { "type": "object", "properties": { "cost": { "$ref": "#/definitions/money.Money" }, "custom_cost": { "$ref": "#/definitions/money.Money" }, "custom_delivery_time": { "type": "integer" }, "declared_value": { "$ref": "#/definitions/money.Money" }, "delivery_time": { "type": "integer" }, "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "reference": { "type": "string" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "dto.WalletResponse": { "type": "object", "properties": { "billing_attributes": { "$ref": "#/definitions/walletdomain.BillingAttribute" }, "billing_type": { "$ref": "#/definitions/walletdomain.BillingType" }, "blocked_credit": { "$ref": "#/definitions/money.Money" }, "current_credit": { "$ref": "#/definitions/money.Money" }, "id": { "type": "string" }, "issues": { "type": "array", "items": { "$ref": "#/definitions/dto.RechargeIssueResponse" } }, "updated_at": { "type": "string" }, "withdrawal_credit_available": { "$ref": "#/definitions/money.Money" } } }, "echo.HTTPError": { "type": "object", "properties": { "message": {} } }, "financialdto.BatchFile": { "type": "object", "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "items_done": { "type": "integer" }, "items_failed": { "type": "integer" }, "origin": { "type": "string" }, "requester": { "type": "string" }, "status": { "type": "string" }, "total": { "type": "integer" }, "type": { "type": "string" }, "url": { "type": "string" } } }, "financialdto.BatchFileItem": { "type": "object", "properties": { "batch_file": { "type": "string" }, "created_at": { "type": "string" }, "data": { "type": "array", "items": { "type": "integer" } }, "error": { "$ref": "#/definitions/financialdto.BatchFileItemError" }, "id": { "type": "string" }, "index": { "type": "integer" }, "status": { "type": "string" } } }, "financialdto.BatchFileItemError": { "type": "object", "properties": { "detail": { "type": "string" } } }, "freights_features_freight_quote.ProductRequest": { "type": "object", "required": [ "height", "length", "quantity", "weight", "width" ], "properties": { "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "quantity": { "type": "integer" }, "reference": { "type": "string" }, "unit_value": { "$ref": "#/definitions/money.Money" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "freights_features_freight_quote.QuoteRequest": { "type": "object", "properties": { "from": { "$ref": "#/definitions/freights_features_freight_quote.SimpleLocation" }, "products": { "type": "array", "items": { "$ref": "#/definitions/freights_features_freight_quote.ProductRequest" } }, "to": { "$ref": "#/definitions/freights_features_freight_quote.SimpleLocation" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/freights_features_freight_quote.VolumeRequest" } } } }, "freights_features_freight_quote.QuoteResponse": { "type": "object", "properties": { "best_quote": { "$ref": "#/definitions/freights_features_freight_quote.ShippingQuoteResponse" }, "cheapest_quote": { "$ref": "#/definitions/freights_features_freight_quote.ShippingQuoteResponse" }, "fastest_quote": { "$ref": "#/definitions/freights_features_freight_quote.ShippingQuoteResponse" }, "quotes": { "type": "array", "items": { "$ref": "#/definitions/freights_features_freight_quote.ShippingQuoteResponse" } } } }, "freights_features_freight_quote.ReverseQuoteRequest": { "type": "object", "required": [ "volume_ids" ], "properties": { "volume_ids": { "type": "array", "minItems": 1, "items": { "type": "string" } } } }, "freights_features_freight_quote.ShippingQuoteResponse": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "custom_delivery_time": { "type": "integer" }, "custom_total_cost": { "$ref": "#/definitions/money.Money" }, "delivery_time": { "type": "integer" }, "display_name": { "type": "string" }, "shipping_method": { "type": "string" }, "total_cost": { "$ref": "#/definitions/money.Money" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/freights_features_freight_quote.VolumeResponse" } } } }, "freights_features_freight_quote.SimpleLocation": { "type": "object", "properties": { "postal_code": { "type": "integer" } } }, "freights_features_freight_quote.VolumeRequest": { "type": "object", "required": [ "height", "length", "reference", "weight", "width" ], "properties": { "declared_value": { "$ref": "#/definitions/money.Money" }, "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "reference": { "type": "string" }, "shipment_type": { "$ref": "#/definitions/optional.Optional-string" }, "type": { "type": "string", "default": "box" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "freights_features_freight_quote.VolumeResponse": { "type": "object", "properties": { "cost": { "$ref": "#/definitions/money.Money" }, "custom_cost": { "$ref": "#/definitions/money.Money" }, "custom_delivery_time": { "type": "integer" }, "declared_value": { "$ref": "#/definitions/money.Money" }, "delivery_time": { "type": "integer" }, "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "reference": { "type": "string" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.CustomerRequest": { "type": "object", "required": [ "document_number", "logistic_address", "logistic_contact", "name" ], "properties": { "code": { "type": "string" }, "document_number": { "type": "string" }, "ie": { "type": "string", "default": "ISENTO" }, "logistic_address": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.LogisticAddress" }, "logistic_contact": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.LogisticContact" }, "name": { "type": "string" }, "packaging": { "$ref": "#/definitions/optional.Optional-pack_Pack" }, "trade_name": { "$ref": "#/definitions/null.String" } } }, "gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.CustomerResponse": { "type": "object", "properties": { "document_number": { "type": "string" }, "id": { "type": "string" }, "ie": { "type": "string" }, "logistic_address": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.LogisticAddress" }, "logistic_contact": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.LogisticContact" }, "name": { "type": "string" }, "operation_slug": { "$ref": "#/definitions/operation.OperationSlug" }, "packagings": { "$ref": "#/definitions/optional.Optional-pack_Pack" }, "trade_name": { "type": "string" } } }, "gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.LogisticAddress": { "type": "object", "required": [ "city", "neighborhood", "number", "postal_code", "state", "street" ], "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "postal_code": { "type": "integer" }, "reference": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } } }, "gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_customers_features.LogisticContact": { "type": "object", "required": [ "email", "name", "phone" ], "properties": { "email": { "type": "string" }, "financial_email": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" } } }, "gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_tms_features.TMSRuleRequest": { "type": "object", "required": [ "action", "condition", "name" ], "properties": { "action": { "type": "string" }, "condition": { "type": "string" }, "name": { "type": "string" } } }, "gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_tms_features.TMSRuleResponse": { "type": "object", "properties": { "action": { "type": "string" }, "condition": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "updated_at": { "type": "string" } } }, "handlers.Composition": { "type": "object", "properties": { "amount": { "$ref": "#/definitions/money.Money" }, "data": { "$ref": "#/definitions/handlers.CompositionData" }, "id": { "type": "string" }, "tracking_code": { "type": "string" }, "transaction_id": { "type": "integer" }, "transaction_type": { "type": "string" }, "volume": { "$ref": "#/definitions/handlers.CompositionVolume" } } }, "handlers.CompositionData": { "type": "object", "properties": { "cost_composition": { "$ref": "#/definitions/handlers.PublicCostComposition" }, "freight_cost": { "$ref": "#/definitions/money.Money" }, "freight_gris": { "$ref": "#/definitions/money.Money" }, "indemnity": { "$ref": "#/definitions/handlers.PublicIndemnityComposition" } } }, "handlers.CompositionVolume": { "type": "object", "properties": { "carrier_slug": { "type": "string" }, "freight_composition": { "$ref": "#/definitions/handlers.SimpleFreightComposition" }, "measures": { "$ref": "#/definitions/handlers.VolumeMeasures" }, "receiver_name": { "type": "string" }, "shipment_id": { "type": "string" }, "status": { "type": "string" } } }, "handlers.CouponMetadataResponse": { "type": "object", "properties": { "erp_plan_subscription": { "$ref": "#/definitions/null.String" }, "input_enabled": { "type": "boolean" } } }, "handlers.CouponPublicResponse": { "type": "object", "properties": { "benefits_customer_bonus_value": { "$ref": "#/definitions/money.Money" }, "code": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "expired" ] } } }, "handlers.DevolutionByTrackingCodeResponse": { "type": "object", "properties": { "carrier_slug": { "type": "string" }, "created_by": { "type": "string" }, "devolution_at": { "type": "string", "example": "2025-03-31" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/handlers.DevolutionVolumeResponse" } } } }, "handlers.DevolutionOperatorResponse": { "type": "object", "properties": { "operators": { "type": "array", "items": { "type": "string" } } } }, "handlers.DevolutionResponse": { "type": "object", "properties": { "carrier_slug": { "type": "string" }, "created_by": { "type": "string" }, "devolution_at": { "type": "string", "example": "2025-03-31" }, "total_volumes": { "type": "integer" } } }, "handlers.DevolutionVolumeResponse": { "type": "object", "properties": { "carrier_slug": { "type": "string" }, "devolution_carrier_slug": { "type": "string" }, "devolution_tracking_code": { "type": "string" }, "id": { "type": "string" }, "id_devolution": { "type": "string" }, "tracking_code": { "type": "string" }, "zpl": { "type": "string" } } }, "handlers.FinancialRequestResponse": { "type": "object", "properties": { "amount": { "$ref": "#/definitions/money.Money" }, "created_at": { "type": "string" }, "customer_id": { "type": "string" }, "customer_name": { "type": "string" }, "description": { "type": "string" }, "due_date": { "type": "string" }, "event_timestamp": { "type": "string" }, "id": { "type": "string" }, "payment_method": { "$ref": "#/definitions/walletdomain.PaymentMethod" }, "period_final": { "type": "string" }, "period_initial": { "type": "string" }, "processed_at": { "type": "string" }, "status": { "$ref": "#/definitions/walletdomain.FinancialStatus" }, "transaction_type": { "$ref": "#/definitions/walletdomain.TransactionType" }, "updated_at": { "type": "string" }, "wallet_id": { "type": "string" } } }, "handlers.GetAndXLSQueryParams": { "type": "object", "required": [ "carrier_slug__in", "devolution_at" ], "properties": { "carrier_slug__in": { "type": "string" }, "devolution_at": { "type": "string", "example": "2025-03-31" } } }, "handlers.HubWithCollectDays": { "type": "object", "properties": { "address": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "collect_days": { "type": "array", "items": { "type": "string" } }, "collection_frequency": { "type": "string" }, "complement": { "type": "string" }, "country": { "type": "string" }, "created_at": { "type": "string" }, "document_number": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "region": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string" }, "store_name": { "type": "string" }, "zip_code": { "type": "string", "example": "0" } } }, "handlers.PDFParams": { "type": "object", "required": [ "carrier_slug__in", "devolution_at" ], "properties": { "carrier_slug__in": { "type": "string" }, "created_by": { "type": "string" }, "devolution_at": { "type": "string", "example": "2025-03-31" } } }, "handlers.PagedTransactions": { "type": "object", "properties": { "limit": { "type": "integer" }, "page": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/handlers.TransactionResponse" } }, "total": { "type": "integer" } } }, "handlers.PagedVolumes": { "type": "object", "properties": { "limit": { "type": "integer" }, "page": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/iofeature.PublicVolumeResponse" } }, "total": { "type": "integer" } } }, "handlers.PostpaidPayable": { "type": "object", "properties": { "amount": { "$ref": "#/definitions/money.Money" }, "due_date": { "type": "string" }, "id": { "type": "string" } } }, "handlers.PostpaidStatusResponse": { "type": "object", "properties": { "open": { "type": "array", "items": { "$ref": "#/definitions/handlers.PostpaidPayable" } }, "overdue": { "type": "array", "items": { "$ref": "#/definitions/handlers.PostpaidPayable" } } } }, "handlers.ProcessWithdrawRequest": { "type": "object", "properties": { "event_timestamp": { "type": "string" }, "status": { "type": "string" } } }, "handlers.PublicCostComposition": { "type": "object", "properties": { "carrier_cost": { "$ref": "#/definitions/money.Money" }, "operational_cost": { "$ref": "#/definitions/money.Money" } } }, "handlers.PublicIndemnityComposition": { "type": "object", "properties": { "incident_at": { "type": "string" }, "incident_value": { "$ref": "#/definitions/money.Money" } } }, "handlers.RequestWithdrawResponse": { "type": "object", "properties": { "id": { "type": "string" } } }, "handlers.SimpleFreightComposition": { "type": "object", "properties": { "cost": { "$ref": "#/definitions/money.Money" }, "gris": { "$ref": "#/definitions/money.Money" } } }, "handlers.TransactionResponse": { "type": "object", "properties": { "compositions": { "type": "array", "items": { "$ref": "#/definitions/handlers.Composition" } }, "created_at": { "type": "string" }, "description": { "type": "string" }, "payment_method": { "type": "string" }, "platform_name": { "type": "string" }, "tracking_codes": { "type": "array", "items": { "type": "string" } }, "transaction_id": { "type": "integer" }, "type": { "type": "string" }, "value": { "$ref": "#/definitions/money.Money" } } }, "handlers.VolumeMeasures": { "type": "object", "properties": { "height": { "type": "number" }, "length": { "type": "number" }, "weight": { "type": "number" }, "width": { "type": "number" } } }, "handlers.WithdrawalConfig": { "type": "object", "properties": { "maximum_amount": { "$ref": "#/definitions/money.Money" }, "minimum_amount": { "$ref": "#/definitions/money.Money" }, "tax": { "$ref": "#/definitions/money.Money" } } }, "handlers.WithdrawalRequest": { "type": "object", "properties": { "amount": { "$ref": "#/definitions/money.Money" }, "payment_details": { "type": "object", "properties": { "observation": { "type": "string" }, "pix_receiver_key": { "type": "string" }, "receiver_email": { "type": "string" } } }, "payment_method": { "type": "string" } } }, "hubdomain.Hub": { "type": "object", "properties": { "address": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "collection_frequency": { "type": "string" }, "complement": { "type": "string" }, "country": { "type": "string" }, "created_at": { "type": "string" }, "document_number": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "region": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string" }, "store_name": { "type": "string" }, "zip_code": { "type": "string", "example": "0" } } }, "integration.Attributes": { "type": "object", "additionalProperties": {} }, "integration.Integration": { "type": "object", "properties": { "attributes": { "$ref": "#/definitions/optional.Optional-integration_Attributes" }, "client_id": { "type": "string" }, "consented_by": { "description": "TODO: Check if the sub claim of the authorization token, could replace this field.", "allOf": [ { "$ref": "#/definitions/null.String" } ] }, "created_at": { "type": "string" }, "created_by": { "$ref": "#/definitions/null.String" }, "customer": { "$ref": "#/definitions/optional.Optional-customer_Customer" }, "customer_id": { "$ref": "#/definitions/uuid.NullUUID" }, "id": { "type": "string" }, "name": { "type": "string" }, "notification_url": { "$ref": "#/definitions/null.String" }, "permissions": { "type": "array", "items": { "$ref": "#/definitions/integration.Permission" } }, "reference": { "$ref": "#/definitions/null.String" }, "updated_at": { "type": "string" } } }, "integration.Permission": { "type": "object", "properties": { "description": { "type": "string" }, "resource": { "type": "string" } } }, "integrations_features_create_integration.BagyAuthURLResponse": { "type": "object", "properties": { "auth_url": { "type": "string" } } }, "integrations_features_create_integration.IntegrationRequest": { "type": "object", "required": [ "name", "permissions" ], "properties": { "client_id": { "type": "string" }, "created_by": { "type": "string" }, "customer_id": { "type": "string" }, "name": { "type": "string" }, "notification_url": { "$ref": "#/definitions/null.String" }, "permissions": { "$ref": "#/definitions/integrations_features_create_integration.Permissions" }, "reference": { "$ref": "#/definitions/null.String" } } }, "integrations_features_create_integration.IntegrationResponse": { "type": "object", "properties": { "created_at": { "type": "string" }, "customer_id": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "notification_url": { "$ref": "#/definitions/null.String" }, "reference": { "$ref": "#/definitions/null.String" } } }, "integrations_features_create_integration.Permissions": { "type": "object", "properties": { "description": { "type": "string" }, "resource": { "type": "string" } } }, "integrations_features_create_integration.ShopifyAuthURLResponse": { "type": "object", "properties": { "auth_url": { "type": "string" } } }, "integrations_features_create_integration.TrayAuthURLResponse": { "type": "object", "properties": { "auth_url": { "type": "string" } } }, "iofeature.Agent": { "type": "object", "required": [ "city", "document_number", "name", "neighborhood", "number", "postal_code", "state", "street" ], "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "document_number": { "type": "string" }, "email": { "type": "string" }, "ie": { "type": "string" }, "name": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "phone": { "type": "string" }, "postal_code": { "type": "integer" }, "reference": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } } }, "iofeature.GatewayHubReceiptInput": { "type": "object", "required": [ "devolution_at", "hub", "tracking_code" ], "properties": { "carrier_slug": { "$ref": "#/definitions/null.String" }, "devolution_at": { "type": "string", "example": "2025-03-31" }, "devolution_tracking_code": { "$ref": "#/definitions/null.String" }, "force_hub": { "type": "boolean" }, "hub": { "$ref": "#/definitions/hubdomain.Hub" }, "operator": { "type": "string" }, "tracking_code": { "type": "string" } } }, "iofeature.GatewayHubReceiptOutput": { "type": "object", "properties": { "can_change_carrier": { "type": "boolean" }, "carrier_slug": { "type": "string" }, "devolution_at": { "type": "string", "example": "2025-03-31" }, "devolution_carrier_slug": { "type": "string" }, "devolution_created_at": { "type": "string" }, "devolution_shipment_id": { "type": "string" }, "devolution_tracking_code": { "type": "string" }, "devolution_volume_id": { "type": "string" }, "tracking_code": { "type": "string" }, "zpl": { "type": "string" } } }, "iofeature.GatewayIssueShippingDetailOutput": { "type": "object", "properties": { "issue": { "$ref": "#/definitions/iofeature.PublicIssue" }, "shipping_quotes": { "$ref": "#/definitions/optional.Optional-iofeature_ShippingQuotes" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/iofeature.PublicVolumeResponse" } } } }, "iofeature.GatewayIssueVolumeOutput": { "type": "object", "properties": { "issue_id": { "type": "string" }, "volume": { "$ref": "#/definitions/iofeature.PublicVolumeResponse" } } }, "iofeature.GatewayProductPayload": { "type": "object", "required": [ "height", "length", "quantity", "weight", "width" ], "properties": { "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "quantity": { "type": "integer" }, "unit_value": { "$ref": "#/definitions/money.Money" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "iofeature.GatewayShipmentPayload": { "type": "object", "required": [ "carrier_slug", "invoice", "receiver" ], "properties": { "carrier_slug": { "type": "string" }, "invoice": { "$ref": "#/definitions/iofeature.Invoice" }, "products": { "type": "array", "items": { "$ref": "#/definitions/iofeature.GatewayProductPayload" } }, "receiver": { "$ref": "#/definitions/iofeature.Agent" }, "reference": { "type": "string" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/iofeature.GatewayVolumePayload" } } } }, "iofeature.GatewayShipmentResponse": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "integration_id": { "type": "string" }, "integration_name": { "type": "string" }, "invoice": { "$ref": "#/definitions/iofeature.Invoice" }, "receiver": { "$ref": "#/definitions/iofeature.Agent" }, "reference": { "type": "string" }, "sender": { "$ref": "#/definitions/iofeature.Agent" }, "shipment_code": { "$ref": "#/definitions/null.String" }, "shipment_status": { "type": "string" }, "shipment_tracking_url": { "type": "string" }, "total_freight_value": { "$ref": "#/definitions/money.Money" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/iofeature.GatewayVolumeResponse" } } } }, "iofeature.GatewayStatisticsResponse": { "type": "object", "properties": { "awaiting_collect": { "type": "integer" }, "delayed": { "type": "integer" }, "delivered": { "type": "integer" }, "not_delivered": { "type": "integer" }, "sent": { "type": "integer" } } }, "iofeature.GatewayStatisticsV2Response": { "type": "object", "properties": { "awaiting_send": { "type": "integer" }, "closed": { "type": "integer" }, "delivered": { "type": "integer" }, "devolution": { "type": "integer" }, "sent": { "type": "integer" } } }, "iofeature.GatewayTrackingResponse": { "type": "object", "properties": { "shipment_code": { "$ref": "#/definitions/null.String" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/iofeature.GatewayTrackingVolumeResponse" } } } }, "iofeature.GatewayTrackingVolumeResponse": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/definitions/iofeature.TrackingEvent" } }, "parent_id": { "$ref": "#/definitions/uuid.NullUUID" }, "shipment_type": { "type": "string" }, "status": { "type": "string" }, "tracking_code": { "type": "string" }, "volume_id": { "type": "string" } } }, "iofeature.GatewayVolumePayload": { "type": "object", "required": [ "height", "length", "weight", "width" ], "properties": { "declared_value": { "$ref": "#/definitions/money.Money" }, "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "reference": { "type": "string" }, "type": { "type": "string", "default": "box" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "iofeature.GatewayVolumeResponse": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "created_at": { "type": "string" }, "declared_value": { "$ref": "#/definitions/money.Money" }, "description": { "$ref": "#/definitions/null.String" }, "freight_composition": { "$ref": "#/definitions/iofeature.SimpleFreightComposition" }, "freight_value": { "$ref": "#/definitions/money.Money" }, "height": { "$ref": "#/definitions/units.Length" }, "id": { "type": "string" }, "length": { "$ref": "#/definitions/units.Length" }, "parent_id": { "$ref": "#/definitions/uuid.NullUUID" }, "reference": { "type": "string" }, "shipment_id": { "type": "string" }, "status": { "type": "string" }, "tracking_code": { "type": "string" }, "tracking_url": { "type": "string" }, "type": { "type": "string", "default": "box" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "iofeature.Invoice": { "type": "object", "properties": { "cfop": { "type": "integer" }, "ie": { "type": "string" }, "issue_date": { "type": "string" }, "key": { "type": "string" }, "number": { "type": "integer" }, "serial_number": { "type": "integer" } } }, "iofeature.IssueQuotes": { "type": "object", "properties": { "cheapest_resend": { "$ref": "#/definitions/optional.Optional-iofeature_PublicShippingQuote" }, "resend": { "type": "array", "items": { "$ref": "#/definitions/iofeature.PublicShippingQuote" } }, "return": { "$ref": "#/definitions/optional.Optional-iofeature_PublicShippingQuote" } } }, "iofeature.Measures": { "type": "object", "properties": { "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "iofeature.PublicDeliveryDetail": { "type": "object", "properties": { "carrier_promissed_date": { "type": "string" }, "olist_promissed_date": { "type": "string" }, "receipt_url": { "$ref": "#/definitions/null.String" } } }, "iofeature.PublicIssue": { "type": "object", "properties": { "action": { "type": "string", "x-nullable": true }, "completed_at": { "type": "string" }, "data": {}, "id": { "type": "string" }, "reason": { "type": "string", "x-nullable": true }, "reference": { "type": "string" }, "reference_type": { "type": "string" }, "resolved_at": { "type": "string" }, "resolved_by": { "type": "string", "x-nullable": true }, "status": { "type": "string" }, "type": { "type": "string" } } }, "iofeature.PublicQuoteVolume": { "type": "object", "properties": { "carrier_return_cost": { "$ref": "#/definitions/money.Money" }, "cost": { "$ref": "#/definitions/money.Money" }, "declared_value": { "$ref": "#/definitions/money.Money" }, "delivery_time": { "type": "integer" }, "height": { "$ref": "#/definitions/units.Length" }, "length": { "$ref": "#/definitions/units.Length" }, "total_cost": { "$ref": "#/definitions/money.Money" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "iofeature.PublicShippingQuote": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "display_name": { "type": "string" }, "shipping_method": { "type": "string" }, "volume": { "$ref": "#/definitions/iofeature.PublicQuoteVolume" } } }, "iofeature.PublicSimpleInvoiceResponse": { "type": "object", "properties": { "issue_date": { "type": "string" }, "key": { "type": "string" }, "number": { "type": "integer" }, "serial_number": { "type": "integer" } } }, "iofeature.PublicSimpleShipmentResponse": { "type": "object", "properties": { "id": { "type": "string" }, "invoice": { "$ref": "#/definitions/iofeature.PublicSimpleInvoiceResponse" }, "operation_slug": { "type": "string" }, "receiver": { "$ref": "#/definitions/iofeature.Agent" }, "reference": { "type": "string" }, "shipment_code": { "$ref": "#/definitions/null.String" } } }, "iofeature.PublicVolumeResponse": { "type": "object", "properties": { "cancelled_at": { "type": "string" }, "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "children": { "type": "array", "items": { "$ref": "#/definitions/iofeature.PublicVolumeResponse" } }, "collected_at": { "type": "string" }, "created_at": { "type": "string" }, "declared_value": { "$ref": "#/definitions/money.Money" }, "delivery_detail": { "$ref": "#/definitions/optional.Optional-iofeature_PublicDeliveryDetail" }, "description": { "$ref": "#/definitions/null.String" }, "events": { "type": "array", "items": { "$ref": "#/definitions/iofeature.TrackingEvent" } }, "expired_at": { "type": "string" }, "freight_composition": { "$ref": "#/definitions/iofeature.SimpleFreightComposition" }, "freight_value": { "$ref": "#/definitions/money.Money" }, "is_operational_error": { "type": "boolean" }, "is_refundable": { "type": "boolean" }, "issue": { "$ref": "#/definitions/optional.Optional-iofeature_PublicIssue" }, "measures": { "$ref": "#/definitions/iofeature.Measures" }, "parent_id": { "$ref": "#/definitions/uuid.NullUUID" }, "receiver_name": { "$ref": "#/definitions/null.String" }, "returned_to_hub_at": { "type": "string" }, "returning_to_hub_at": { "type": "string" }, "shipment": { "$ref": "#/definitions/optional.Optional-iofeature_PublicSimpleShipmentResponse" }, "shipment_id": { "type": "string" }, "shipment_reference": { "type": "string" }, "shipment_type": { "type": "string" }, "status": { "type": "string" }, "sub_status": { "$ref": "#/definitions/null.String" }, "tracking_code": { "type": "string" }, "transit_time": { "type": "integer" }, "volume_id": { "type": "string" }, "volume_reference": { "type": "string" } } }, "iofeature.ShippingQuotes": { "type": "object", "properties": { "quotes": { "$ref": "#/definitions/iofeature.IssueQuotes" }, "reference": { "type": "string" }, "resend_receiver_postal_code": { "type": "integer" } } }, "iofeature.SimpleFreightComposition": { "type": "object", "properties": { "cost": { "$ref": "#/definitions/money.Money" }, "gris": { "$ref": "#/definitions/money.Money" }, "return_cost": { "$ref": "#/definitions/money.Money" }, "tax": { "$ref": "#/definitions/money.Money" } } }, "iofeature.TrackingEvent": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "datetime": { "type": "string" }, "description": { "$ref": "#/definitions/null.String" }, "status": { "$ref": "#/definitions/null.String" }, "sub_status": { "$ref": "#/definitions/null.String" }, "title": { "$ref": "#/definitions/null.String" }, "tracking_code": { "type": "string" } } }, "issuedomain.IssueAction": { "type": "string", "enum": [ "resend", "return", "no_action" ], "x-enum-varnames": [ "IssueActionShipResend", "IssueActionShipReturn", "IssueActionNon" ] }, "issues_devolution.ShipmentIssueHandleInput": { "type": "object", "required": [ "carrier_slug", "quote_reference", "receiver", "shipping_type" ], "properties": { "carrier_slug": { "type": "string" }, "quote_reference": { "type": "string" }, "receiver": { "$ref": "#/definitions/valueobject.Agent" }, "shipping_type": { "enum": [ "resend", "return" ], "allOf": [ { "$ref": "#/definitions/issuedomain.IssueAction" } ] } } }, "money.Money": { "type": "integer", "format": "int64", "enum": [ 1, 100 ], "x-enum-varnames": [ "Cent", "Real" ] }, "null.Float": { "type": "object", "properties": { "float64": { "type": "number", "format": "float64" }, "valid": { "description": "Valid is true if Float64 is not NULL", "type": "boolean" } } }, "null.String": { "type": "object", "properties": { "string": { "type": "string" }, "valid": { "description": "Valid is true if String is not NULL", "type": "boolean" } } }, "operation.OperationSlug": { "type": "object", "properties": { "string": { "type": "string" }, "valid": { "description": "Valid is true if String is not NULL", "type": "boolean" } } }, "optional.Optional-customer_Customer": { "type": "object", "properties": { "t": { "$ref": "#/definitions/customer.Customer" }, "valid": { "type": "boolean" } } }, "optional.Optional-integration_Attributes": { "type": "object", "properties": { "t": { "$ref": "#/definitions/integration.Attributes" }, "valid": { "type": "boolean" } } }, "optional.Optional-iofeature_PublicDeliveryDetail": { "type": "object", "properties": { "t": { "$ref": "#/definitions/iofeature.PublicDeliveryDetail" }, "valid": { "type": "boolean" } } }, "optional.Optional-iofeature_PublicIssue": { "type": "object", "properties": { "t": { "$ref": "#/definitions/iofeature.PublicIssue" }, "valid": { "type": "boolean" } } }, "optional.Optional-iofeature_PublicShippingQuote": { "type": "object", "properties": { "t": { "$ref": "#/definitions/iofeature.PublicShippingQuote" }, "valid": { "type": "boolean" } } }, "optional.Optional-iofeature_PublicSimpleShipmentResponse": { "type": "object", "properties": { "t": { "$ref": "#/definitions/iofeature.PublicSimpleShipmentResponse" }, "valid": { "type": "boolean" } } }, "optional.Optional-iofeature_ShippingQuotes": { "type": "object", "properties": { "t": { "$ref": "#/definitions/iofeature.ShippingQuotes" }, "valid": { "type": "boolean" } } }, "optional.Optional-pack_Pack": { "type": "object", "properties": { "t": { "$ref": "#/definitions/pack.Pack" }, "valid": { "type": "boolean" } } }, "optional.Optional-string": { "type": "object", "properties": { "t": { "type": "string" }, "valid": { "type": "boolean" } } }, "optional.Optional-walletdomain_Card": { "type": "object", "properties": { "t": { "$ref": "#/definitions/walletdomain.Card" }, "valid": { "type": "boolean" } } }, "pack.Builder": { "type": "object", "required": [ "height", "length", "weight", "width" ], "properties": { "customer_id": { "type": "string" }, "height": { "minimum": 1, "allOf": [ { "$ref": "#/definitions/units.Length" } ] }, "length": { "minimum": 1, "allOf": [ { "$ref": "#/definitions/units.Length" } ] }, "weight": { "minimum": 1, "allOf": [ { "$ref": "#/definitions/units.Weight" } ] }, "width": { "minimum": 1, "allOf": [ { "$ref": "#/definitions/units.Length" } ] } } }, "pack.Pack": { "type": "object", "properties": { "created_at": { "type": "string" }, "customer_id": { "type": "string" }, "height": { "$ref": "#/definitions/units.Length" }, "id": { "type": "string" }, "length": { "$ref": "#/definitions/units.Length" }, "updated_at": { "type": "string" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "pagination.PageResult-gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_tms_features_TMSRuleResponse": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/gitlab_olist_io_envios_envios-apps_apis_api-gateway_internal_tms_features.TMSRuleResponse" } }, "total": { "type": "integer" } } }, "pagination.PageResult-handlers_FinancialRequestResponse": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/handlers.FinancialRequestResponse" } }, "total": { "type": "integer" } } }, "pagination.PageResult-iofeature_GatewayIssueVolumeOutput": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/iofeature.GatewayIssueVolumeOutput" } }, "total": { "type": "integer" } } }, "pagination.PageResult-shipments_list_GatewayShipmentResponse": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/shipments_list.GatewayShipmentResponse" } }, "total": { "type": "integer" } } }, "pagination.PageResult-subscriptions_guaranteed_refund_SubscriptionResponse": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/subscriptions_guaranteed_refund.SubscriptionResponse" } }, "total": { "type": "integer" } } }, "printlabel.LabelRequest": { "type": "object", "properties": { "invoice_keys": { "type": "array", "items": { "type": "string" } }, "references": { "type": "array", "items": { "type": "string" } }, "shipments": { "type": "array", "items": { "type": "string" } }, "volumes": { "type": "array", "items": { "type": "string" } } } }, "pudo.NearestPudo": { "type": "object", "properties": { "nearest": { "$ref": "#/definitions/pudo.Pudo" }, "others": { "type": "array", "items": { "$ref": "#/definitions/pudo.Pudo" } } } }, "pudo.Pudo": { "type": "object", "properties": { "address": { "type": "string" }, "carrier_slug": { "type": "string" }, "city": { "type": "string" }, "complement": { "$ref": "#/definitions/null.String" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "name": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "state": { "type": "string" }, "state_code": { "type": "string" }, "working_days": { "$ref": "#/definitions/pudo.WorkingDay" }, "zip_code": { "type": "string", "example": "0" } } }, "pudo.WorkingDay": { "type": "object", "properties": { "holidays": { "$ref": "#/definitions/pudo.WorkingHours" }, "saturday": { "$ref": "#/definitions/pudo.WorkingHours" }, "sunday": { "$ref": "#/definitions/pudo.WorkingHours" }, "weekday": { "$ref": "#/definitions/pudo.WorkingHours" } } }, "pudo.WorkingHours": { "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" } } }, "shipmentdomain.InvoiceAndCarriers": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/shipmentdomain.InvoiceAndCarriersItem" } } } }, "shipmentdomain.InvoiceAndCarriersItem": { "type": "object", "properties": { "carrier_slugs": { "type": "array", "items": { "type": "string" } }, "invoice_key": { "type": "string" } } }, "shipments_cart.CartItemResponse": { "type": "object", "properties": { "created_at": { "type": "string" }, "created_by": { "type": "string" }, "expires_at": { "type": "string" }, "reference": { "type": "string" }, "shipment_request": { "$ref": "#/definitions/dto.GatewayShipmentPayload" }, "shipping_quote": { "$ref": "#/definitions/dto.ShippingQuoteResponse" } } }, "shipments_cart.CartResponse": { "type": "object", "properties": { "cart_items": { "type": "array", "items": { "$ref": "#/definitions/shipments_cart.CartItemResponse" } }, "customer_id": { "type": "string" }, "total": { "$ref": "#/definitions/money.Money" } } }, "shipments_list.Agent": { "type": "object", "required": [ "city", "document_number", "name", "neighborhood", "number", "postal_code", "state", "street" ], "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "document_number": { "type": "string" }, "email": { "type": "string" }, "ie": { "type": "string" }, "name": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "phone": { "type": "string" }, "postal_code": { "type": "integer" }, "reference": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } } }, "shipments_list.GatewayShipmentResponse": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "created_at": { "type": "string" }, "customer_id": { "type": "string" }, "id": { "type": "string" }, "integration_id": { "type": "string" }, "integration_name": { "type": "string" }, "invoice": { "$ref": "#/definitions/shipments_list.Invoice" }, "receiver": { "$ref": "#/definitions/shipments_list.Agent" }, "reference": { "type": "string" }, "sender": { "$ref": "#/definitions/shipments_list.Agent" }, "shipment_code": { "$ref": "#/definitions/null.String" }, "shipment_status": { "type": "string" }, "shipment_tracking_url": { "type": "string" }, "total_freight_value": { "$ref": "#/definitions/money.Money" }, "volumes": { "type": "array", "items": { "$ref": "#/definitions/shipments_list.GatewayVolumeResponse" } } } }, "shipments_list.GatewayVolumeResponse": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "created_at": { "type": "string" }, "declared_value": { "$ref": "#/definitions/money.Money" }, "freight_value": { "$ref": "#/definitions/money.Money" }, "height": { "$ref": "#/definitions/units.Length" }, "id": { "type": "string" }, "length": { "$ref": "#/definitions/units.Length" }, "parent_id": { "$ref": "#/definitions/uuid.NullUUID" }, "reference": { "type": "string" }, "shipment_id": { "type": "string" }, "status": { "type": "string" }, "tracking_code": { "type": "string" }, "tracking_url": { "type": "string" }, "type": { "type": "string", "default": "box" }, "weight": { "$ref": "#/definitions/units.Weight" }, "width": { "$ref": "#/definitions/units.Length" } } }, "shipments_list.Invoice": { "type": "object", "properties": { "cfop": { "type": "integer" }, "ie": { "type": "string" }, "issue_date": { "type": "string" }, "key": { "type": "string" }, "number": { "type": "integer" }, "serial_number": { "type": "integer" } } }, "shipments_list.InvoiceUsageRequest": { "type": "object", "properties": { "invoice_keys": { "type": "array", "items": { "type": "string" } } } }, "shipments_reverse.CreateReverseShipmentRequest": { "type": "object", "required": [ "next_carrier_slug", "original_volume_ids" ], "properties": { "next_carrier_slug": { "type": "string" }, "original_volume_ids": { "type": "array", "items": { "type": "string" } } } }, "standerr.Detail": { "type": "object", "additionalProperties": {} }, "standerr.ErrorType": { "type": "string", "enum": [ "ClientError", "RetryableError", "InternalError", "ExternalError", "CriticalError" ], "x-enum-varnames": [ "ErrClient", "ErrRetryable", "ErrInternal", "ErrExternal", "ErrCritical" ] }, "standerr.FriendlyError": { "type": "object", "properties": { "message": { "type": "string" }, "support_url": { "type": "string" } } }, "standerr.StandardError": { "type": "object", "properties": { "cause": {}, "code": { "type": "integer" }, "detail": { "$ref": "#/definitions/standerr.Detail" }, "friendly": { "$ref": "#/definitions/standerr.FriendlyError" }, "group": { "type": "string" }, "trace_id": { "type": "string" }, "type": { "$ref": "#/definitions/standerr.ErrorType" } } }, "stickydomain.CuttingTimeSticky": { "type": "object", "properties": { "datetime": { "type": "string" }, "display_datetime": { "type": "string" }, "event_type": { "type": "string" } } }, "stickydomain.PackageSticky": { "type": "object", "properties": { "labeled_count": { "type": "integer" } } }, "stickydomain.SellerSticky": { "type": "object", "properties": { "availabilities": { "$ref": "#/definitions/collections.Availabilities" }, "operation_slug": { "$ref": "#/definitions/operation.OperationSlug" } } }, "stickydomain.Sticky": { "type": "object", "properties": { "collection": { "$ref": "#/definitions/collections.Collection" }, "cutting_time": { "$ref": "#/definitions/stickydomain.CuttingTimeSticky" }, "packages": { "$ref": "#/definitions/stickydomain.PackageSticky" }, "pudo": { "$ref": "#/definitions/pudo.NearestPudo" }, "seller": { "$ref": "#/definitions/stickydomain.SellerSticky" }, "sticky_status": { "$ref": "#/definitions/stickydomain.StickyStatus" } } }, "stickydomain.StickyStatus": { "type": "string", "enum": [ "waiting_confirmation", "collection_confirmed", "collection_performed", "collection_incomplete", "collection_canceled", "collection_canceled_by_olist", "collection_not_today", "nearest_pudo_available" ], "x-enum-varnames": [ "WaitingConfirmation", "CollectionConfirmed", "CollectionPerformed", "CollectionIncomplete", "CollectionCanceled", "CollectionCanceledByOlist", "CollectionNotToday", "NearestPudoAvailable" ] }, "subscriptions_guaranteed_refund.SubscriptionResponse": { "type": "object", "properties": { "customer_id": { "type": "string" }, "data": { "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "subscribed_at": { "type": "string" }, "type": { "type": "string" }, "unsubscribed_at": { "type": "string" } } }, "tracking.Location": { "type": "object", "properties": { "city": { "$ref": "#/definitions/null.String" }, "lat": { "$ref": "#/definitions/null.String" }, "long": { "$ref": "#/definitions/null.String" }, "raw": { "$ref": "#/definitions/null.String" }, "state": { "$ref": "#/definitions/null.String" } } }, "tracking.Tracking": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_promissed_date": { "type": "string" }, "carrier_slug": { "type": "string" }, "carrier_status": { "type": "string" }, "created_at": { "type": "string" }, "datetime": { "type": "string" }, "description": { "$ref": "#/definitions/null.String" }, "end_status": { "type": "boolean" }, "extra_data": { "type": "string" }, "hash": { "type": "string" }, "id": { "type": "string" }, "location": { "$ref": "#/definitions/tracking.Location" }, "occurrence": { "type": "boolean" }, "raw_event": { "type": "array", "items": { "type": "integer" } }, "status": { "$ref": "#/definitions/null.String" }, "sub_status": { "$ref": "#/definitions/null.String" }, "title": { "$ref": "#/definitions/null.String" }, "tracking_code": { "type": "string" } } }, "trackingfeature.GatewayTracking": { "type": "object", "properties": { "carrier_name": { "type": "string" }, "carrier_slug": { "type": "string" }, "delivery_detail": { "$ref": "#/definitions/trackingfeature.GatewayTrackingDeliveryDetail" }, "events": { "type": "array", "items": { "$ref": "#/definitions/tracking.Tracking" } }, "shipment_code": { "type": "string" }, "shipment_type": { "type": "string" }, "tracking_code": { "type": "string" }, "transit_time": { "type": "integer" } } }, "trackingfeature.GatewayTrackingDeliveryDetail": { "type": "object", "properties": { "carrier_promissed_date": { "type": "string" }, "olist_promissed_date": { "type": "string" }, "transit_time": { "type": "integer" } } }, "transactionfeature.Composition": { "type": "object", "properties": { "amount": { "$ref": "#/definitions/money.Money" }, "data": { "$ref": "#/definitions/transactionfeature.CompositionData" }, "id": { "type": "string" }, "tracking_code": { "type": "string" }, "transaction_id": { "type": "integer" }, "transaction_type": { "type": "string" }, "volume": { "$ref": "#/definitions/transactionfeature.CompositionVolume" } } }, "transactionfeature.CompositionData": { "type": "object", "properties": { "cost_composition": { "$ref": "#/definitions/transactionfeature.PublicCostComposition" }, "divergence": { "$ref": "#/definitions/transactionfeature.PublicDivergenceComposition" }, "freight_cost": { "$ref": "#/definitions/money.Money" }, "freight_gris": { "$ref": "#/definitions/money.Money" }, "indemnity": { "$ref": "#/definitions/transactionfeature.PublicIndemnityComposition" } } }, "transactionfeature.CompositionVolume": { "type": "object", "properties": { "carrier_slug": { "type": "string" }, "freight_composition": { "$ref": "#/definitions/transactionfeature.SimpleFreightComposition" }, "measures": { "$ref": "#/definitions/transactionfeature.VolumeMeasures" }, "receiver_name": { "type": "string" }, "shipment_id": { "type": "string" }, "status": { "type": "string" }, "volume_id": { "type": "string" } } }, "transactionfeature.PublicCostComposition": { "type": "object", "properties": { "carrier_cost": { "$ref": "#/definitions/money.Money" }, "operational_cost": { "$ref": "#/definitions/money.Money" } } }, "transactionfeature.PublicDivergenceComposition": { "type": "object", "properties": { "carrier_cost": { "$ref": "#/definitions/money.Money" }, "cubed_weight": { "type": "number" }, "height": { "type": "number" }, "length": { "type": "number" }, "used_weight_type": { "type": "string" }, "weight": { "type": "number" }, "width": { "type": "number" } } }, "transactionfeature.PublicIndemnityComposition": { "type": "object", "properties": { "incident_at": { "type": "string" }, "incident_value": { "$ref": "#/definitions/money.Money" } } }, "transactionfeature.SimpleFreightComposition": { "type": "object", "properties": { "cost": { "$ref": "#/definitions/money.Money" }, "gris": { "$ref": "#/definitions/money.Money" } } }, "transactionfeature.TransactionDetailResponse": { "type": "object", "properties": { "compositions": { "type": "array", "items": { "$ref": "#/definitions/transactionfeature.Composition" } }, "created_at": { "type": "string" }, "description": { "type": "string" }, "payment_method": { "type": "string" }, "platform_name": { "type": "string" }, "transaction_id": { "type": "integer" }, "type": { "type": "string" }, "value": { "$ref": "#/definitions/money.Money" }, "wallet_id": { "type": "string" } } }, "transactionfeature.VolumeMeasures": { "type": "object", "properties": { "cubed_weight": { "type": "number" }, "height": { "type": "number" }, "length": { "type": "number" }, "weight": { "type": "number" }, "width": { "type": "number" } } }, "units.Length": { "type": "integer", "format": "int64", "enum": [ 1, 10, 1000 ], "x-enum-varnames": [ "Millimetre", "Centimeter", "Meter" ] }, "units.Weight": { "type": "integer", "format": "int64", "enum": [ 1, 1000 ], "x-enum-varnames": [ "Gram", "Kilogram" ] }, "uuid.NullUUID": { "type": "object", "properties": { "uuid": { "type": "string" }, "valid": { "description": "Valid is true if UUID is not NULL", "type": "boolean" } } }, "valueobject.Agent": { "type": "object", "required": [ "city", "country", "document_number", "name", "neighborhood", "number", "state", "street", "zip_code" ], "properties": { "city": { "type": "string" }, "company_name": { "type": "string" }, "complement": { "type": "string" }, "country": { "type": "string" }, "document_number": { "type": "string" }, "email": { "type": "string" }, "ie": { "type": "string" }, "name": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "phone": { "type": "string" }, "reference": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "zip_code": { "type": "integer" } } }, "walletdomain.AutomaticRechargeData": { "type": "object", "properties": { "card": { "$ref": "#/definitions/optional.Optional-walletdomain_Card" }, "recharge_value": { "$ref": "#/definitions/money.Money" }, "threshold": { "$ref": "#/definitions/money.Money" } } }, "walletdomain.BillingAttribute": { "type": "object", "properties": { "postpaid": { "$ref": "#/definitions/walletdomain.BillingAttributePostpaid" }, "prepaid": { "$ref": "#/definitions/walletdomain.BillingAttributePrepaid" } } }, "walletdomain.BillingAttributePostpaid": { "type": "object", "properties": { "payment_method": { "$ref": "#/definitions/walletdomain.PaymentMethod" } } }, "walletdomain.BillingAttributePrepaid": { "type": "object", "properties": { "automatic_recharge_data": { "$ref": "#/definitions/walletdomain.AutomaticRechargeData" }, "automatic_recharge_enabled": { "type": "boolean" } } }, "walletdomain.BillingType": { "type": "string", "enum": [ "postpaid", "prepaid" ], "x-enum-varnames": [ "BillingTypePostPaid", "BillingTypePrePaid" ] }, "walletdomain.Card": { "type": "object", "properties": { "alias": { "type": "string" }, "brand": { "type": "string" }, "expiration_month": { "type": "string" }, "expiration_year": { "type": "string" }, "first_digits": { "type": "string" }, "holder_name": { "type": "string" }, "id": { "type": "string" }, "last_digits": { "type": "string" }, "status": { "type": "string" } } }, "walletdomain.FinancialStatus": { "type": "string", "enum": [ "pending", "approved", "rejected", "refunded" ], "x-enum-varnames": [ "FinancialStatusPending", "FinancialStatusApproved", "FinancialStatusRejected", "FinancialStatusRefunded" ] }, "walletdomain.PaymentMethod": { "type": "string", "enum": [ "pix", "bank_slip", "credit_card" ], "x-enum-varnames": [ "PaymentMethodPix", "PaymentMethodBankSlip", "PaymentMethodCreditCard" ] }, "walletdomain.TransactionType": { "type": "string", "enum": [ "bonus", "bonus_expire", "divergence_reversal", "label_reversal", "freight_compensation", "cashback", "credit_added", "label_return", "label_resend", "divergence", "indemnity", "indemnity_reversal", "label_canceled", "revert_label_canceled", "label_purchase", "withdrawal_requested", "withdrawal_done", "withdrawal_fee", "withdrawal_canceled", "devolution_fee", "credit_dispute", "credit_refunded", "credit_dispute_closed", "credit_add_reversed", "differential_aliquot", "collection_fee" ], "x-enum-varnames": [ "TransactionTypeBonus", "TransactionTypeBonusExpire", "TransactionTypeDivergenceReversal", "TransactionTypeLabelReversal", "TransactionTypeFreightCompensation", "TransactionTypeCashback", "TransactionTypeCreditAdded", "TransactionTypeLabelReturn", "TransactionTypeLabelResend", "TransactionTypeDivergence", "TransactionTypeIndemnity", "TransactionTypeIndemnityReversal", "TransactionTypeLabelCanceled", "TransactionTypeRevertLabelCanceled", "TransactionTypeLabelPurchase", "TransactionTypeWithdrawalRequested", "TransactionTypeWithdrawalDone", "TransactionTypeWithdrawalFee", "TransactionTypeWithdrawalCanceled", "TransactionTypeDevolutionFee", "TransactionTypeCreditDispute", "TransactionTypeCreditRefunded", "TransactionTypeCreditDisputeClosed", "TransactionTypeCreditAddReversed", "TransactionTypeDifferentialAliquot", "TransactionTypeCollectionFee" ] }, "wallets_billing.ConfigurePrepaidResponse": { "type": "object", "properties": { "financial_request_id": { "$ref": "#/definitions/uuid.NullUUID" }, "wallet": { "$ref": "#/definitions/dto.WalletResponse" } } }, "wallets_deposit.DepositMetadataResponse": { "type": "object", "properties": { "automatic_recharge_min_threshold": { "$ref": "#/definitions/money.Money" }, "automatic_recharge_min_value": { "$ref": "#/definitions/money.Money" }, "credit_card_request_timeout_seconds": { "type": "integer" }, "payment_method_available": { "type": "array", "items": { "type": "string" } }, "recharge_min_value": { "$ref": "#/definitions/money.Money" } } }, "wallets_deposit.DepositRequestData": { "type": "object", "properties": { "amount": { "$ref": "#/definitions/money.Money" }, "payment_details": { "type": "array", "items": { "type": "integer" } }, "payment_method": { "$ref": "#/definitions/walletdomain.PaymentMethod" } } }, "wallets_deposit.DepositResponse": { "type": "object", "properties": { "amount": { "$ref": "#/definitions/money.Money" }, "event_timestamp": { "type": "string" }, "id": { "type": "string" }, "payment_banking_data": {}, "payment_method": { "$ref": "#/definitions/walletdomain.PaymentMethod" }, "payment_method_detail": { "$ref": "#/definitions/null.String" }, "status": { "type": "string" }, "transaction_type": { "type": "string" } } }, "wallets_deposit.RecreateRequestData": { "type": "object", "properties": { "due_date": { "type": "string" } } } } }