{ "swagger": "2.0", "info": { "description": "API for Shipping", "title": "Geliver API", "termsOfService": "http://geliver.io/api/terms", "contact": { "name": "API Support", "url": "http://www.geliver.io/support", "email": "ercumenteser@geliver.io" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0" }, "host": "api.geliver.io", "basePath": "/api/v1", "paths": { "/addresses": { "get": { "description": "List addresses of current user's organization", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Address" ], "operationId": "List Addresses", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/Address" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "post": { "description": "Creates a new address for current user's organization", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Address" ], "operationId": "Create Address", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Address object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Address" } } ], "responses": { "201": { "description": "Created", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Address" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/addresses/{addressID}": { "get": { "description": "Fetch an address of current user's organization", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Address" ], "operationId": "Get Address by ID", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of Address as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "addressID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Address" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "delete": { "description": "Delete address of current user's organization", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Address" ], "operationId": "Delete Address", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of Address as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "addressID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GeliverResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/cities": { "get": { "description": "Get City", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "City" ], "operationId": "Get City", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "number", "description": "CityCode is city code in a country ('34' for Istanbul) or state postal code ('AL' for Alabama)", "name": "cityCode", "in": "query", "required": true }, { "type": "string", "description": "ISO2 Code of the country (e.g TR for Turkey", "name": "countryCode", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/City" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/districts": { "get": { "description": "List districts", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "District" ], "operationId": "List Districts by City Code", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "number", "description": "City Code in a country", "name": "cityCode", "in": "query" }, { "type": "string", "description": "ISO2 Code of the country (e.g TR for Turkey", "name": "countryCode", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/District" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/districts/{districtID}": { "get": { "description": "Get District", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "District" ], "operationId": "Get District by District ID", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "number", "description": "ID is Geliver specific district ID", "name": "districtID", "in": "path", "required": true }, { "type": "number", "description": "City Code in a country", "name": "cityCode", "in": "query" }, { "type": "string", "description": "ISO2 Code of the country (e.g TR for Turkey", "name": "countryCode", "in": "query" }, { "type": "string", "description": "Language Code", "name": "languageCode", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/District" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/members": { "get": { "description": "List transactions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Organization" ], "operationId": "List members of current organization", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/Organization" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "post": { "description": "Gives authorization to a user in your organization", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Organization Member" ], "operationId": "Invite a user as a Member of your organization by user id or email", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Organization member object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationMember" } } ], "responses": { "201": { "description": "Created", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/OrganizationMember" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/members/{userID}": { "get": { "description": "Finds a member of your organization by member id", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Organization Member" ], "operationId": "Get a member of your organization by Member ID", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of user as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "userID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/OrganizationMember" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "patch": { "description": "Updates existing authorization of a member", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Organization Member" ], "operationId": "Update Organization", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Organization object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationMemberPatch" } }, { "type": "string", "description": "ID of user as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "userID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/OrganizationMember" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/organizations": { "get": { "description": "List transactions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Organization" ], "operationId": "List Organizations of current user", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/Organization" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "post": { "description": "Creates a new organization", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Organization" ], "operationId": "Create Organization", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Organization object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Organization" } } ], "responses": { "201": { "description": "Created", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Organization" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/organizations/{organizationID}": { "get": { "description": "Fetch organization", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Organization" ], "operationId": "Get Organization by ID", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of organization as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "organizationID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Organization" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "patch": { "description": "Updates a new shipment", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Organization" ], "operationId": "Update Organization", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Organization object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationUpdateRequest" } }, { "type": "string", "description": "ID of organization as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "organizationID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Organization" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/parceltemplates": { "get": { "description": "List Parcel Templates", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Parcel Template" ], "operationId": "List Parcel Templates", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/ParcelTemplate" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "post": { "description": "Creates a new parcel template", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Parcel Template" ], "operationId": "Create Parcel Template", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Parcel template object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ParcelTemplate" } } ], "responses": { "201": { "description": "Created", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/ParcelTemplate" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/parceltemplates/{parcelTemplateID}": { "get": { "description": "Fetch address", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Parcel Template" ], "operationId": "Get Parcel Template by ID", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of Parcel Template as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "parcelTemplateID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/ParcelTemplate" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "delete": { "description": "Delete parcel template", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Parcel Template" ], "operationId": "Delete Parcel Template", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of Parcel Template as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "parcelTemplateID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GeliverResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/provideraccounts": { "get": { "description": "List Provider Accounts", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Provider Account" ], "operationId": "List Provider Accounts", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/ProviderAccount" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "post": { "description": "Creates a new provider account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Provider Account" ], "operationId": "Create Provider Account", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Parcel template object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProviderAccount" } } ], "responses": { "201": { "description": "Created", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/ProviderAccount" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "delete": { "description": "Delete Provider Account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Provider Account" ], "operationId": "Delete Provider Account", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/ProviderAccount" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/provideraccounts/{providerAccountID}": { "get": { "description": "Fetch provider account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Provider Account" ], "operationId": "Get Provider Account by ID", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of Provider Account as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "providerAccountID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/ProviderAccount" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "patch": { "description": "Updates a provider account", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Provider Account" ], "operationId": "UpdateProviderAccount", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Provider Account object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProviderAccountRequest" } }, { "type": "string", "description": "ID of provider account as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "providerAccountID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/ProviderAccount" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/providers": { "get": { "description": "List Providers", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Provider" ], "operationId": "List Providers", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/Provider" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/providers/{providerCode}": { "get": { "description": "Fetch provider", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Provider" ], "operationId": "Get Provider by Code", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "Code of provider", "name": "providerCode", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Provider" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/providerservices": { "get": { "description": "List Provider Services", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Provider Service" ], "operationId": "List Provider Services", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "Code of Provider", "name": "providerCode", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/ProviderService" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/providerservices/{providerServiceCode}": { "get": { "description": "Fetch provider service", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Provider Service" ], "operationId": "Get Provider Service by ID", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "Code of Provider Service", "name": "providerServiceCode", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/ProviderAccount" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/shipment/{shipmentID}/items": { "get": { "description": "Fetch Shipment Item", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Item" ], "operationId": "Get Shipment Items", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of shipment as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "shipmentID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/Item" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "post": { "description": "Creates a new organization", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Item" ], "operationId": "Create Shipment Item", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Item object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Item" } } ], "responses": { "201": { "description": "Created", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Organization" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "patch": { "description": "Updates shipment item", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Item" ], "operationId": "Update Item", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Item object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrganizationUpdateRequest" } }, { "type": "string", "description": "ID of item as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "itemID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Item" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/shipments": { "get": { "description": "List shipments", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "operationId": "List Shipments", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "integer", "description": "Page number", "name": "page", "in": "query" }, { "type": "integer", "description": "Rows per page", "name": "limit", "in": "query" }, { "type": "integer", "description": "Field to sort by", "name": "sortBy", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/Shipment" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "post": { "description": "Creates a new shipment", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "operationId": "Create Shipment", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Shipment object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Shipment" } } ], "responses": { "201": { "description": "Created", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/definitions/Shipment" }, { "type": "object", "properties": { "extra": { "$ref": "#/definitions/ParcelExtras" } } } ] } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/shipments/{shipmentID}": { "get": { "description": "Fetch shipment", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "operationId": "Get Shipment by ID", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of shipment as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "shipmentID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Shipment" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "patch": { "description": "Updates a new shipment", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "operationId": "Update Shipment", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Shipment object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ShipmentPatch" } }, { "type": "string", "description": "ID of shipment as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "shipmentID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Shipment" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/transactions": { "get": { "description": "List transactions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Transaction" ], "operationId": "List Transactions", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/Transaction" } } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } }, "post": { "description": "Creates a new transaction", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Transaction" ], "operationId": "Create Transaction", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "description": "Transaction object", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Transaction" } } ], "responses": { "201": { "description": "Created", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Shipment" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/transactions/{transactionID}": { "get": { "description": "Fetch transaction", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Transaction" ], "operationId": "Get Transaction by ID", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true }, { "type": "string", "description": "ID of transaction as UUID (Example: 4a5929c1-c6e6-4cbf-93db-01da91da9bfb)", "name": "transactionID", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/Transaction" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } }, "/user/balance": { "get": { "description": "Get balance", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "User" ], "operationId": "Get current user's Balance", "parameters": [ { "type": "string", "description": "Bearer Token (Example: Bearer foo)", "name": "Authorization", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/GeliverResponse" }, { "type": "object", "properties": { "data": { "type": "number" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "402": { "description": "Payment Required", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/GeliverErrorResponse" } } } } } }, "definitions": { "Address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "allOf": [ { "$ref": "#/definitions/City" } ], "readOnly": true }, "cityCode": { "type": "string" }, "cityName": { "type": "string" }, "countryCode": { "type": "string" }, "countryName": { "type": "string" }, "createdAt": { "type": "string", "readOnly": true }, "district": { "allOf": [ { "$ref": "#/definitions/District" } ], "readOnly": true }, "districtID": { "description": "DistrictID *common.DbUUID `json:\"districtID\" ts_type:\"string\" swaggertype:\"string\" format:\"uuid4\" `", "type": "integer" }, "districtName": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "isActive": { "type": "boolean" }, "isDefaultReturnAddress": { "type": "boolean" }, "isDefaultSenderAddress": { "type": "boolean" }, "isInvoiceAddress": { "type": "boolean" }, "isRecipientAddress": { "type": "boolean" }, "metadata": { "type": "object" }, "name": { "type": "string" }, "owner": { "type": "string", "readOnly": true }, "phone": { "type": "string" }, "shortName": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "streetID": { "type": "string", "format": "uuid4" }, "streetName": { "type": "string" }, "test": { "type": "boolean" }, "updatedAt": { "type": "string", "readOnly": true }, "zip": { "type": "string" } } }, "City": { "type": "object", "properties": { "areaCode": { "type": "string" }, "cityCode": { "type": "string" }, "countryCode": { "type": "string" }, "name": { "description": "Model", "type": "string" } } }, "Cod": { "type": "object", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" }, "paymentMethod": { "type": "string" } } }, "District": { "type": "object", "properties": { "cityCode": { "type": "string" }, "countryCode": { "type": "string" }, "districtID": { "type": "integer" }, "name": { "description": "Model", "type": "string" } } }, "GeliverErrorResponse": { "type": "object", "properties": { "additionalMessage": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "result": { "type": "boolean", "default": false } } }, "GeliverResponse": { "type": "object", "properties": { "additionalMessage": { "type": "string" }, "code": { "type": "string" }, "data": {}, "message": { "type": "string" }, "result": { "type": "boolean", "default": true } } }, "Insurance": { "type": "object", "properties": { "amount": { "type": "number" }, "content": { "type": "string" }, "currency": { "type": "string", "example": "TL" }, "provider": { "type": "string" } } }, "Item": { "type": "object", "properties": { "countryOfOrigin": { "type": "string" }, "createdAt": { "type": "string", "readOnly": true }, "currency": { "type": "string", "example": "TL" }, "currencyLocal": { "type": "string", "example": "TL" }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "massUnit": { "type": "string" }, "maxDeliveryTime": { "type": "string" }, "maxShipTime": { "type": "string" }, "owner": { "type": "string", "readOnly": true }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "test": { "type": "boolean" }, "title": { "type": "string" }, "totalPrice": { "type": "number" }, "totalPriceLocal": { "type": "number" }, "unitPrice": { "type": "number" }, "unitPriceLocal": { "type": "number", "example": 20 }, "unitWeight": { "type": "number", "readOnly": true, "example": 1 }, "updatedAt": { "type": "string", "readOnly": true }, "variantTitle": { "type": "string" } } }, "Offer": { "type": "object", "properties": { "amount": { "type": "number", "readOnly": true, "example": 17.5 }, "amountLocal": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountLocalOld": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountLocalTax": { "type": "number", "readOnly": true, "example": 17.5 }, "amountLocalVat": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountOld": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountTax": { "type": "number", "readOnly": true, "example": 17.5 }, "amountVat": { "type": "number", "readOnly": true, "example": 17.5 }, "averageEstimatedTime": { "type": "integer", "readOnly": true }, "averageEstimatedTimeHumanReadible": { "type": "string" }, "bonusBalance": { "type": "number", "readOnly": true, "example": 17.5 }, "createdAt": { "type": "string", "readOnly": true }, "currency": { "type": "string", "example": "TL" }, "currencyLocal": { "type": "string", "example": "TL" }, "discountRate": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "durationTerms": { "type": "string", "readOnly": true }, "estimatedArrivalTime": { "type": "string", "readOnly": true }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "integrationType": { "type": "string" }, "isAccepted": { "type": "boolean", "readOnly": true }, "isC2C": { "type": "boolean", "readOnly": true }, "isGlobal": { "type": "boolean", "readOnly": true }, "isMainOffer": { "type": "boolean" }, "maxEstimatedTime": { "type": "integer", "readOnly": true }, "minEstimatedTime": { "type": "integer", "readOnly": true }, "owner": { "type": "string", "readOnly": true }, "providerAccountID": { "type": "string", "format": "uuid4", "readOnly": true, "example": "" }, "providerCode": { "type": "string", "readOnly": true }, "providerServiceCode": { "type": "string", "readOnly": true }, "rating": { "type": "number", "readOnly": true }, "shipmentTime": { "type": "string", "readOnly": true }, "test": { "type": "boolean" }, "totalAmount": { "type": "number", "readOnly": true, "example": 17.5 }, "totalAmountLocal": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "updatedAt": { "type": "string", "readOnly": true } } }, "OfferList": { "type": "object", "properties": { "allowOfferFallback": { "type": "boolean", "readOnly": true }, "cheapest": { "allOf": [ { "$ref": "#/definitions/Offer" } ], "readOnly": true }, "createdAt": { "type": "string", "readOnly": true }, "fastest": { "allOf": [ { "$ref": "#/definitions/Offer" } ], "readOnly": true }, "height": { "type": "number", "readOnly": true, "example": 1 }, "itemIDs": { "type": "array", "items": { "type": "string" }, "readOnly": true }, "length": { "type": "number", "readOnly": true, "example": 1 }, "list": { "type": "array", "items": { "$ref": "#/definitions/Offer" }, "readOnly": true }, "owner": { "type": "string", "readOnly": true }, "parcelIDs": { "type": "array", "items": { "type": "string" } }, "parcelTemplateID": { "type": "string", "format": "uuid4", "readOnly": true, "example": "" }, "percentageCompleted": { "type": "number", "readOnly": true }, "providerAccountIDs": { "type": "array", "items": { "type": "string" } }, "providerCodes": { "type": "array", "items": { "type": "string" } }, "providerServiceCodes": { "type": "array", "items": { "type": "string" } }, "test": { "type": "boolean" }, "totalOffersCompleted": { "type": "integer", "readOnly": true }, "totalOffersRequested": { "type": "integer", "readOnly": true }, "updatedAt": { "type": "string", "readOnly": true }, "weight": { "type": "number", "readOnly": true, "example": 1 }, "width": { "type": "number", "readOnly": true, "example": 1 } } }, "Order": { "type": "object", "properties": { "buyerShipmentMethod": { "type": "string" }, "buyerShippingCost": { "type": "number" }, "buyerShippingCostCurrency": { "type": "string" }, "createdAt": { "type": "string", "readOnly": true }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "itemIDs": { "type": "array", "items": { "type": "string" } }, "merchantCode": { "type": "string" }, "notes": { "type": "string" }, "orderCode": { "type": "string" }, "orderNumber": { "type": "string" }, "orderStatus": { "description": "1=order created 2=got offers 3=offer accepted 4=labels created", "type": "string" }, "organizationID": { "type": "string", "format": "uuid4" }, "owner": { "type": "string", "readOnly": true }, "shipment": { "allOf": [ { "$ref": "#/definitions/Shipment" } ], "readOnly": true }, "sourceCode": { "type": "string" }, "sourceIdentifier": { "type": "string" }, "test": { "type": "boolean" }, "totalAmount": { "type": "number" }, "totalAmountCurrency": { "type": "string" }, "totalTax": { "type": "number" }, "updatedAt": { "type": "string", "readOnly": true } } }, "Organization": { "type": "object", "properties": { "additionalJsonData": { "type": "object" }, "agreementSigned": { "type": "boolean" }, "agreementSignedDate": { "type": "string" }, "bonusBalance": { "type": "number", "readOnly": true }, "categoryCode": { "type": "string" }, "citizen": { "type": "string" }, "cityCode": { "type": "string" }, "countryCode": { "type": "string" }, "couponId": { "$ref": "#/definitions/common.DbUUID" }, "createdAt": { "type": "string", "readOnly": true }, "creditBalance": { "type": "number", "readOnly": true }, "creditLimit": { "type": "number", "readOnly": true }, "debitBalance": { "type": "number", "readOnly": true }, "defaultCardName": { "type": "string" }, "defaultCardSource": { "type": "string" }, "defaultDistanceUnit": { "type": "string" }, "defaultInvoiceAddress": { "$ref": "#/definitions/Address" }, "defaultInvoiceAddressID": { "type": "string", "format": "uuid4" }, "defaultMassUnit": { "description": "LimitToAskPayment common.DbDecimal `gorm:\"type:numberic;default:0\" json:\"-\" ts_type:\"number\" swaggertype:\"number,float\" readonly:\"true\"`", "type": "string" }, "defaultReturnAddress": { "$ref": "#/definitions/Address" }, "defaultReturnAddressID": { "type": "string", "format": "uuid4" }, "defaultSenderAddress": { "$ref": "#/definitions/Address" }, "defaultSenderAddressID": { "type": "string", "format": "uuid4" }, "defaultUser": { "$ref": "#/definitions/User" }, "defaultUserID": { "type": "string", "format": "uuid4" }, "email": { "type": "string" }, "facebook": { "type": "string" }, "firstPaymentCompleted": { "type": "boolean" }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "instagram": { "type": "string" }, "isApprovedReference": { "type": "boolean" }, "isBetaTester": { "type": "boolean" }, "isIndividual": { "type": "boolean" }, "isSenderSmsActivated": { "type": "boolean" }, "isTurkishTaxVerified": { "type": "boolean" }, "lastInvoiceAt": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "owner": { "type": "string", "readOnly": true }, "phone": { "type": "string" }, "placeOfResidenceBarcode": { "type": "string" }, "referenceBy": { "type": "string" }, "taxAdministration": { "type": "string" }, "taxNumber": { "type": "string" }, "test": { "type": "boolean" }, "twitter": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string", "readOnly": true }, "useBalanceAsPriority": { "type": "boolean" }, "userName": { "type": "string" }, "website": { "type": "string" } } }, "OrganizationMember": { "type": "object", "properties": { "createdAt": { "type": "string", "readOnly": true }, "dailyAmountLimit": { "type": "number", "readOnly": true, "example": 100 }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "lastDayUsage": { "type": "number", "readOnly": true, "example": 100 }, "lastMonthUsage": { "type": "number", "readOnly": true, "example": 100 }, "monthlyAmountLimit": { "type": "number", "readOnly": true, "example": 100 }, "organizationID": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "owner": { "type": "string", "readOnly": true }, "roles": { "type": "array", "items": { "type": "string" } }, "test": { "type": "boolean" }, "updatedAt": { "type": "string", "readOnly": true }, "userEmail": { "type": "string" }, "userID": { "type": "string", "format": "uuid4", "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" } } }, "OrganizationMemberPatch": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } } } }, "OrganizationUpdateRequest": { "type": "object", "properties": { "additionalJsonData": { "type": "object" }, "cityCode": { "type": "string" }, "countryCode": { "type": "string" }, "defaultDistanceUnit": { "type": "string" }, "defaultMassUnit": { "type": "string" }, "defaultSenderAddressID": { "type": "string" }, "email": { "type": "string" }, "facebook": { "type": "string" }, "instagram": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "taxAdministration": { "type": "string" }, "taxNumber": { "type": "string" }, "twitter": { "type": "string" }, "useBalanceAsPriority": { "type": "boolean" }, "username": { "type": "string" }, "website": { "type": "string" } } }, "Parcel": { "type": "object", "properties": { "amount": { "type": "number", "readOnly": true, "example": 17.5 }, "amountLocal": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountLocalOld": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountLocalTax": { "type": "number", "readOnly": true, "example": 17.5 }, "amountLocalVat": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountOld": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountTax": { "type": "number", "readOnly": true, "example": 17.5 }, "amountVat": { "type": "number", "readOnly": true, "example": 17.5 }, "barcode": { "type": "string", "readOnly": true }, "bonusBalance": { "type": "number", "readOnly": true, "example": 17.5 }, "commercialInvoiceUrl": { "type": "string", "readOnly": true }, "createdAt": { "type": "string", "readOnly": true }, "currency": { "type": "string", "example": "TL" }, "currencyLocal": { "type": "string", "example": "TL" }, "customsDeclaration": { "type": "string" }, "desi": { "description": "Desi of parcel", "type": "number", "readOnly": true, "example": 1 }, "discountRate": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "distanceUnit": { "description": "Distance unit of parcel", "type": "string", "enum": [ "cm" ] }, "eta": { "type": "string", "readOnly": true }, "extra": { "type": "object" }, "height": { "description": "Height of parcel", "type": "number", "readOnly": true, "example": 1 }, "hidePackageContentOnTag": { "type": "boolean" }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "invoiceGenerated": { "type": "boolean" }, "invoiceID": { "$ref": "#/definitions/common.DbUUID" }, "isMainParcel": { "type": "boolean" }, "itemIDs": { "type": "array", "items": { "type": "string" } }, "labelFileType": { "type": "string", "enum": [ "PDF", "JPG", "ZPLII", "ZPL" ], "example": "PDF" }, "labelURL": { "type": "string", "readOnly": true }, "length": { "description": "Length of parcel", "type": "number", "readOnly": true, "example": 1 }, "massUnit": { "description": "Weight unit of parcel", "type": "string", "enum": [ "kg", "lb" ] }, "metadata": { "description": "Meta data as JSON object to add additional info on your shipment/parcel", "type": "object" }, "metadataText": { "description": "Meta string to add additional info on your shipment/parcel", "type": "string" }, "oldDesi": { "type": "number", "readOnly": true, "example": 1 }, "oldWeight": { "type": "number", "readOnly": true, "example": 1 }, "owner": { "type": "string", "readOnly": true }, "parcelReferenceCode": { "type": "string" }, "parcelTemplateID": { "description": "Instead of setting parcel size manually, you can set this to a predefined Parcel Template", "type": "string", "format": "uuid4", "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "productPaymentOnDelivery": { "type": "boolean" }, "qrCodeUrl": { "type": "string", "readOnly": true }, "refundInvoiceID": { "allOf": [ { "$ref": "#/definitions/common.DbUUID" } ], "readOnly": true }, "responsiveLabelURL": { "type": "string", "readOnly": true }, "shipmentDate": { "type": "string", "readOnly": true }, "shipmentID": { "type": "string", "format": "uuid4", "readOnly": true }, "stateCode": { "type": "string" }, "template": { "type": "string" }, "test": { "type": "boolean" }, "totalAmount": { "type": "number", "readOnly": true, "example": 17.5 }, "totalAmountLocal": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "trackingNumber": { "description": "Tracking number", "type": "string", "readOnly": true }, "trackingStatus": { "$ref": "#/definitions/models.Tracking" }, "trackingUrl": { "type": "string", "readOnly": true }, "updatedAt": { "type": "string", "readOnly": true }, "useDimensionsOfItems": { "description": "If true, auto calculates total parcel size using the size of items", "type": "boolean" }, "useWeightOfItems": { "description": "If true, auto calculates total parcel weight using the weight of items", "type": "boolean" }, "weight": { "description": "Weight of parcel", "type": "number", "readOnly": true, "example": 1 }, "width": { "description": "Width of parcel", "type": "number", "readOnly": true, "example": 1 } } }, "ParcelExtras": { "type": "object", "properties": { "COD": { "$ref": "#/definitions/Cod" }, "insurance": { "$ref": "#/definitions/Insurance" } } }, "ParcelTemplate": { "type": "object", "properties": { "createdAt": { "type": "string", "readOnly": true }, "desi": { "description": "Desi of parcel", "type": "number", "readOnly": true, "example": 1 }, "distanceUnit": { "description": "Distance unit of parcel", "type": "string", "enum": [ "cm" ] }, "height": { "description": "Height of parcel", "type": "number", "readOnly": true, "example": 1 }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "isActive": { "type": "boolean" }, "languageCode": { "type": "string" }, "length": { "description": "Length of parcel", "type": "number", "readOnly": true, "example": 1 }, "massUnit": { "description": "Weight unit of parcel", "type": "string", "enum": [ "kg", "lb" ] }, "name": { "type": "string" }, "oldDesi": { "type": "number", "readOnly": true, "example": 1 }, "oldWeight": { "type": "number", "readOnly": true, "example": 1 }, "owner": { "type": "string", "readOnly": true }, "test": { "type": "boolean" }, "updatedAt": { "type": "string", "readOnly": true }, "weight": { "description": "Weight of parcel", "type": "number", "readOnly": true, "example": 1 }, "width": { "description": "Width of parcel", "type": "number", "readOnly": true, "example": 1 } } }, "Provider": { "type": "object", "properties": { "c2cByDefault": { "type": "boolean" }, "code": { "type": "string" }, "createdAt": { "type": "string", "readOnly": true }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "instruction": { "type": "string" }, "instructionForCustomer": { "type": "string" }, "integrationType": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string", "readOnly": true }, "test": { "type": "boolean" }, "updatedAt": { "type": "string", "readOnly": true } } }, "ProviderAccount": { "type": "object", "properties": { "createdAt": { "type": "string", "readOnly": true }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "integrationType": { "type": "string" }, "isActive": { "type": "boolean" }, "isC2C": { "type": "boolean" }, "labelFileType": { "type": "string" }, "owner": { "type": "string", "readOnly": true }, "parameters": { "type": "object" }, "providerCode": { "type": "string" }, "test": { "type": "boolean" }, "updatedAt": { "type": "string", "readOnly": true }, "username": { "type": "string" }, "version": { "type": "integer" } } }, "ProviderAccountRequest": { "type": "object", "properties": { "id": { "type": "string" }, "isActive": { "type": "boolean" }, "parameters": { "type": "object" }, "password": { "type": "string" }, "providerCode": { "type": "string" }, "username": { "type": "string" }, "version": { "type": "integer" } } }, "ProviderService": { "type": "object", "properties": { "averageEstimatedTime": { "type": "integer" }, "averageRating": { "type": "number" }, "code": { "type": "string" }, "createdAt": { "type": "string", "readOnly": true }, "durationTerms": { "type": "string" }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "languageCode": { "type": "string" }, "maxEstimatedTime": { "type": "integer" }, "minEstimatedTime": { "type": "integer" }, "name": { "type": "string" }, "owner": { "type": "string", "readOnly": true }, "productPaymentOnDelivery": { "type": "boolean" }, "providerCode": { "type": "string" }, "test": { "type": "boolean" }, "updatedAt": { "type": "string", "readOnly": true } } }, "Shipment": { "type": "object", "required": [ "senderAddressID" ], "properties": { "acceptedOffer": { "allOf": [ { "$ref": "#/definitions/Offer" } ], "readOnly": true }, "acceptedOfferID": { "type": "string", "format": "uuid4", "readOnly": true, "example": "" }, "amount": { "type": "number", "readOnly": true, "example": 17.5 }, "amountLocal": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountLocalOld": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountLocalTax": { "type": "number", "readOnly": true, "example": 17.5 }, "amountLocalVat": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountOld": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountTax": { "type": "number", "readOnly": true, "example": 17.5 }, "amountVat": { "type": "number", "readOnly": true, "example": 17.5 }, "barcode": { "type": "string", "readOnly": true }, "bonusBalance": { "type": "number", "readOnly": true, "example": 17.5 }, "buyerNote": { "type": "string" }, "cancelDate": { "description": "Duzelticelek", "type": "string" }, "categoryCode": { "type": "string" }, "commercialInvoiceUrl": { "type": "string", "readOnly": true }, "createReturnLabel": { "type": "boolean" }, "createdAt": { "type": "string", "readOnly": true }, "currency": { "type": "string", "example": "TL" }, "currencyLocal": { "type": "string", "example": "TL" }, "customsDeclaration": { "type": "string" }, "desi": { "description": "Desi of parcel", "type": "number", "readOnly": true, "example": 1 }, "discountRate": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "distanceUnit": { "description": "Distance unit of parcel", "type": "string", "enum": [ "cm" ] }, "enableAutomation": { "type": "boolean" }, "eta": { "type": "string", "readOnly": true }, "extraParcels": { "type": "array", "items": { "$ref": "#/definitions/Parcel" } }, "hasError": { "type": "boolean" }, "height": { "description": "Height of parcel", "type": "number", "readOnly": true, "example": 1 }, "hidePackageContentOnTag": { "type": "boolean" }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "invoiceGenerated": { "type": "boolean" }, "invoiceID": { "$ref": "#/definitions/common.DbUUID" }, "isRecipientSmsActivated": { "type": "boolean" }, "isReturn": { "type": "boolean" }, "isReturned": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/definitions/Item" } }, "labelFileType": { "type": "string", "enum": [ "PDF", "JPG", "ZPLII", "ZPL" ], "example": "PDF" }, "labelURL": { "type": "string", "readOnly": true }, "lastErrorCode": { "type": "string" }, "lastErrorMessage": { "type": "string", "readOnly": true }, "length": { "description": "Length of parcel", "type": "number", "readOnly": true, "example": 1 }, "massUnit": { "description": "Weight unit of parcel", "type": "string", "enum": [ "kg", "lb" ] }, "metadata": { "description": "Meta data as JSON object to add additional info on your shipment/parcel", "type": "object" }, "metadataText": { "description": "Meta string to add additional info on your shipment/parcel", "type": "string" }, "offers": { "allOf": [ { "$ref": "#/definitions/OfferList" } ], "readOnly": true }, "oldDesi": { "type": "number", "readOnly": true, "example": 1 }, "oldWeight": { "type": "number", "readOnly": true, "example": 1 }, "order": { "$ref": "#/definitions/Order" }, "orderID": { "type": "string", "format": "uuid4", "example": "" }, "organizationShipmentID": { "type": "integer" }, "owner": { "type": "string", "readOnly": true }, "parcelTemplateID": { "description": "Instead of setting parcel size manually, you can set this to a predefined Parcel Template", "type": "string", "format": "uuid4", "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "productPaymentOnDelivery": { "type": "boolean" }, "providerAccountID": { "type": "string", "format": "uuid4", "readOnly": true, "example": "" }, "providerAccountIDs": { "type": "array", "items": { "type": "string" } }, "providerBranchName": { "type": "string", "readOnly": true }, "providerCode": { "type": "string", "readOnly": true }, "providerCodes": { "type": "array", "items": { "type": "string" } }, "providerInvoiceNo": { "type": "string", "readOnly": true }, "providerReceiptNo": { "type": "string", "readOnly": true }, "providerSerialNo": { "type": "string", "readOnly": true }, "providerServiceCode": { "type": "string", "readOnly": true }, "providerServiceCodes": { "type": "array", "items": { "type": "string" } }, "qrCodeUrl": { "type": "string", "readOnly": true }, "recipientAddress": { "$ref": "#/definitions/Address" }, "recipientAddressID": { "type": "string", "format": "uuid4", "example": "" }, "refundInvoiceID": { "allOf": [ { "$ref": "#/definitions/common.DbUUID" } ], "readOnly": true }, "responsiveLabelURL": { "type": "string", "readOnly": true }, "returnAddressID": { "type": "string", "format": "uuid4", "example": "" }, "sellerNote": { "type": "string" }, "senderAddress": { "$ref": "#/definitions/Address" }, "senderAddressID": { "type": "string", "format": "uuid4", "example": "" }, "shipmentDate": { "type": "string", "readOnly": true }, "statusCode": { "type": "string", "enum": [ "CREATED", "GOT_OFFERS", "OFFER_ACCEPTED", "TRACKING_CODE_CREATED", "LABEL_PRINTED", "SHIPPED", "DELIVERED", "CANCELED", "RETURNED", "RETURN_SHIPPED", "FAILED" ], "readOnly": true }, "tags": { "type": "array", "items": { "type": "string" } }, "test": { "type": "boolean" }, "totalAmount": { "type": "number", "readOnly": true, "example": 17.5 }, "totalAmountLocal": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "trackingNumber": { "description": "Tracking number", "type": "string", "readOnly": true }, "trackingStatus": { "$ref": "#/definitions/models.Tracking" }, "trackingUrl": { "type": "string", "readOnly": true }, "updatedAt": { "type": "string", "readOnly": true }, "useDimensionsOfItems": { "description": "If true, auto calculates total parcel size using the size of items", "type": "boolean" }, "useWeightOfItems": { "description": "If true, auto calculates total parcel weight using the weight of items", "type": "boolean" }, "weight": { "description": "Weight of parcel", "type": "number", "readOnly": true, "example": 1 }, "width": { "description": "Width of parcel", "type": "number", "readOnly": true, "example": 1 } } }, "ShipmentPatch": { "type": "object", "properties": { "distanceUnit": { "type": "string" }, "extraParcel": { "type": "array", "items": { "$ref": "#/definitions/ShipmentUpdateExtraParcel" } }, "height": { "$ref": "#/definitions/common.DbDecimal" }, "hidePackageContentOnTag": { "type": "boolean" }, "isRecipientSMSActivated": { "type": "boolean" }, "length": { "$ref": "#/definitions/common.DbDecimal" }, "massUnit": { "type": "string" }, "merchantCode": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": true }, "order": { "$ref": "#/definitions/Order" }, "parcelTemplateID": { "type": "string" }, "productPaymentOnDelivery": { "type": "boolean" }, "recipientAddress": { "$ref": "#/definitions/Address" }, "weight": { "$ref": "#/definitions/common.DbDecimal" }, "width": { "$ref": "#/definitions/common.DbDecimal" } } }, "ShipmentUpdateExtraParcel": { "type": "object", "properties": { "distanceUnit": { "type": "string" }, "height": { "$ref": "#/definitions/common.DbDecimal" }, "hidePackageContentOnTag": { "type": "boolean" }, "length": { "$ref": "#/definitions/common.DbDecimal" }, "massUnit": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": true }, "parcelId": { "type": "string" }, "parcelTemplateID": { "type": "string" }, "productPaymentOnDelivery": { "type": "boolean" }, "weight": { "$ref": "#/definitions/common.DbDecimal" }, "width": { "$ref": "#/definitions/common.DbDecimal" } } }, "Transaction": { "type": "object", "properties": { "amount": { "type": "number", "readOnly": true, "example": 17.5 }, "amountLocal": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountLocalOld": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountLocalTax": { "type": "number", "readOnly": true, "example": 17.5 }, "amountLocalVat": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountOld": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "amountTax": { "type": "number", "readOnly": true, "example": 17.5 }, "amountVat": { "type": "number", "readOnly": true, "example": 17.5 }, "bonusBalance": { "type": "number", "readOnly": true, "example": 17.5 }, "cancelDescription": { "type": "string" }, "createdAt": { "type": "string", "readOnly": true }, "currency": { "type": "string", "example": "TL" }, "currencyLocal": { "type": "string", "example": "TL" }, "description": { "type": "string" }, "discountRate": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "invoiceID": { "allOf": [ { "$ref": "#/definitions/common.DbUUID" } ], "readOnly": true }, "isCanceled": { "type": "boolean" }, "isCustomAccountCharge": { "type": "boolean" }, "isPayed": { "type": "boolean" }, "isRefund": { "type": "boolean" }, "offerID": { "type": "string", "format": "uuid4", "example": "" }, "owner": { "type": "string", "readOnly": true }, "payedVia": { "type": "string" }, "shipment": { "$ref": "#/definitions/Shipment" }, "test": { "type": "boolean" }, "totalAmount": { "type": "number", "readOnly": true, "example": 17.5 }, "totalAmountLocal": { "type": "number", "format": "float", "readOnly": true, "example": 17.5 }, "transactionType": { "type": "string" }, "updatedAt": { "type": "string", "readOnly": true } } }, "User": { "type": "object", "properties": { "ban_message": { "type": "string" }, "ban_reason_type": { "type": "integer" }, "createdAt": { "type": "string", "readOnly": true }, "email": { "type": "string" }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "is_banned": { "type": "boolean" }, "kvkk": { "type": "boolean" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string", "readOnly": true }, "phone": { "type": "string" }, "role": { "type": "string" }, "test": { "type": "boolean" }, "updatedAt": { "type": "string", "readOnly": true } } }, "common.DbDecimal": { "type": "object", "properties": { "decimal.Decimal": { "type": "number" } } }, "common.DbUUID": { "type": "object", "properties": { "uuid.UUID": { "type": "string" } } }, "models.Tracking": { "type": "object", "properties": { "createdAt": { "type": "string", "readOnly": true }, "hash": { "type": "string", "readOnly": true }, "id": { "type": "string", "format": "uuid4", "readOnly": true, "example": "4a5929c1-c6e6-4cbf-93db-01da91da9bfb" }, "locationName": { "type": "string", "readOnly": true }, "owner": { "type": "string", "readOnly": true }, "statusDate": { "type": "string", "readOnly": true }, "statusDetails": { "type": "string", "readOnly": true }, "test": { "type": "boolean" }, "trackingStatusCode": { "type": "string", "readOnly": true }, "trackingSubStatusCode": { "type": "string", "readOnly": true }, "updatedAt": { "type": "string", "readOnly": true } } } } }