This is an email to + be sent
+ text: + type: string + description: >- + The text body of the email. If none is provided this will be + generated from the HTML. Max size of 2 MB. + + If max size is exceeded, the entire api call will fail. + example: This is the text version of the email + EmailEventListModel: + type: object + additionalProperties: false + properties: + events: + type: array + items: + $ref: '#/components/schemas/EmailEvent' + EmailEvent: + type: object + additionalProperties: false + properties: + messageId: + type: string + description: The id of the message. + example: id1 + eventType: + description: Contains a code for what event type the event is. + example: 3 + oneOf: + - $ref: '#/components/schemas/EmailEventType' + eventTypeDescription: + type: string + description: A text description of the event type + example: Delivered + eventTimestamp: + type: string + description: When the event happened e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + EmailEventType: + type: integer + description: |- + 0 = Undefined + 1 = Clicked + 2 = Complained + 3 = Delivered + 4 = Opened + 5 = PermanentFail + 6 = TemporaryFail + 7 = Unsubscribed + 8 = Queued + 9 = Attempt + x-enumNames: + - Undefined + - Clicked + - Complained + - Delivered + - Opened + - PermanentFail + - TemporaryFail + - Unsubscribed + - Queued + - Attempt + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + ApiPageModelOfEmailTemplateOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfEmailTemplateOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfEmailTemplateOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/EmailTemplateOutputApiModel' + EmailTemplateOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the email template + example: c9b6c7a8-aa22-4a59-b6d5-fdbbeced27bc + name: + type: string + description: The name of the email template + example: My email template + html: + type: string + description: The Html of the email template + example: >- +Hello {name} {lastname}. + This is an email to be sent
+ text: + type: string + description: The text version of the Html + example: Hello {name} This is the text version of the email + subject: + type: string + description: The subject of the email template + example: Hello {lastname} This is the subject of the email + preheader: + type: string + description: The preheader of the email + example: This is the preheader of the email + placeholders: + type: array + description: >- + A list of the placeholders found in the template html, text and + subject. + example: + - '{name}' + - '{lastname}' + items: + type: string + created: + type: string + description: >- + When the email template was created e.g. 2001-02-30T14:50:23Z (UTC + time) + example: '2001-02-30T14:50:23Z' + lastUpdated: + type: string + description: >- + When the email template was last updated e.g. 2001-02-30T14:50:23Z + (UTC time) + example: '2001-02-30T14:50:23Z' + RequestDeletionOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The Id of the Deletion request + example: cf97f715-63d4-41df-92a1-34eb87b866b5 + DeletionRequestCreateInfo: + type: object + additionalProperties: false + properties: + numberInfo: + $ref: '#/components/schemas/NumberInfo' + ApiPageModelOfGroupOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfGroupOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfGroupOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/GroupOutputApiModel' + GroupOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the list + format: guid + example: a80e5daa-1bf9-48ca-b67e-ff79eeab1c39 + name: + type: string + description: The name of the list + example: My list + created: + type: string + description: When the list was created e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + GroupInputApiModel: + type: object + additionalProperties: false + properties: + name: + type: string + ApiPageModelOfRecipientOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfRecipientOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfRecipientOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/RecipientOutputApiModel' + RecipientOutputApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the recipient + format: guid + example: 99e0543f-b059-4127-9b50-c42112f19cc9 + listId: + type: string + description: The id of the list that the recipient belongs to + format: guid + example: 4a5f91d5-3aa4-4419-890e-f7b103406dbf + created: + type: string + description: >- + When the recipient was created e.g. 2001-02-30T14:50:23Z (UTC + time) + example: '2001-02-30T14:50:23Z' + RecipientBaseApiModel: + type: object + x-abstract: true + additionalProperties: false + properties: + externalCreated: + type: string + description: >- + When the recipient was created in an external system e.g. + 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + numberInfo: + $ref: '#/components/schemas/NumberInfo' + fields: + description: The fields to update in the given recipient. + example: + firstname: Friedhelm + lastname: Hillebrand + birthday: '1945-04-30' + custom1: Custom1 + custom2: Custom2 + custom3: Custom3 + custom4: Custom4 + custom5: Custom5 + custom6: Custom6 + email: test@test.dk + zipCode: '8000' + address: testroad 12 + companyName: test company + oneOf: + - $ref: '#/components/schemas/RecipientFieldsCollection' + RecipientFieldsCollection: + type: object + additionalProperties: + type: string + RecipientCreateOrUpdateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + RecipientUpdateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + RecipientCreateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + IncomingMessageListModel: + type: object + additionalProperties: false + properties: + messages: + type: array + items: + $ref: '#/components/schemas/IncomingMessage' + IncomingMessage: + type: object + additionalProperties: false + properties: + from: + $ref: '#/components/schemas/IncomingMessageSender' + to: + $ref: '#/components/schemas/IncomingMessageTarget' + text: + type: string + receivedAt: + type: string + example: '2001-02-30T14:50:23Z' + IncomingMessageSender: + type: object + additionalProperties: false + properties: + countryCode: + type: string + phoneNumber: + type: string + rawSource: + type: string + isValidMsisdn: + type: boolean + IncomingMessageTarget: + type: object + additionalProperties: false + properties: + countryCode: + type: string + phoneNumber: + type: string + msisdn: + type: string + SmsOutgoingPostReply: + type: object + additionalProperties: false + properties: + results: + type: array + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateResultModel' + SmsOutgoingApiCreateResultModel: + type: object + additionalProperties: false + properties: + numberDetails: + description: >- + The parsed details about the msisdn provided in the to-field of the + request (msisdn is a number with a countrycode e.g. 4512345678) + oneOf: + - $ref: '#/components/schemas/NumberDetails' + text: + type: string + description: The text message + example: This is a message text to be sent + from: + type: string + description: The sender. + example: PetShop + smsCount: + type: integer + description: >- + The number of sms messages this message will be split into when sent + to the operator. Charging will also be done according to this + number. + format: int32 + example: 1 + messageId: + type: string + description: >- + An optional message id used to identify the message. + + If no message id is provided, a new message id is generated and + assigned to the message. This id must be unique across all messages + created on the same account. + + (In case a previous message has been deleted according to GDPR + deletion rules setup on the specific account, the messageId is + allowed to be reused) + example: PetShop + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2". In case + the message was submitted with encoding "auto", this report will + reveal the final encoding based on the characters in the message + text. + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + example: gsm7 + NumberDetails: + type: object + additionalProperties: false + properties: + countryCode: + type: string + description: The country code part of the msisdn, e.g. 45. + example: '45' + phoneNumber: + type: string + description: The phone number part of the msisdn, e.g. 12345678. + example: '12345678' + rawMsisdn: + type: string + description: >- + The input msisdn in its unaltered format. This is the value provided + when sending the text message. + example: 45 12 34 56 78 + msisdn: + type: string + description: The final cleaned msisdn + example: '4512345678' + isValidMsisdn: + type: boolean + description: True if the input msisdn was valid. + example: true + countryHint: + type: string + description: The country code hint if provided in the request + SmsOutgoingPostRequest: + type: object + additionalProperties: false + required: + - messages + properties: + messages: + type: array + description: >- + A list of the sms messages to be sent. Allowed to contain between 1 + and 250 elements. + maxItems: 250 + minItems: 1 + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateModel' + SmsOutgoingApiCreateModel: + allOf: + - $ref: '#/components/schemas/SmsOutgoingBaseApiModel' + - type: object + additionalProperties: false + required: + - text + - from + properties: + text: + type: string + description: >- + The text message. + + If the max length is exceeded, the message text is truncated and + sent. + maxLength: 10000 + minLength: 1 + example: This is a message text to be sent + from: + type: string + description: >- + The sender. This can either be a 3-11 chars text sender or an up + to 14 digit long sender number. + + If the max length is exceeded, the string is truncated. + minLength: 1 + example: PetShop + flash: + type: boolean + description: >- + If true, the message will be shown as a flash message (also + known as a class0 message) on the target phone. If false, it + will be received as a standard text message. + + Default: false + nullable: true + example: false + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7", "ucs2" or + "auto". + + "gsm7" is the default alfabet for text messages and when using + gsm7, a single sms message can contain 160 characters. If the + length exceeeds 160 characters, the message is actually split up + into parts of 153 characters and charged according to this. + Please note, that a few, specific characters fill up 2 bytes and + count for 2 letters. Ref: + https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along + with smileys. When using this encoding, a single message can + consist of 70 characters. If the message exceeds 70 characters, + the final message is actually split into parts of 67 characters. + + "auto" can be used in case the sender wishes to support + non-roman characters but wants to save the expenses on all the + trafic that only contains gsm characters anyway. + + Default: "gsm7" + example: gsm7 + SmsOutgoingBaseApiModel: + type: object + additionalProperties: false + required: + - to + properties: + to: + type: string + description: >- + The msisdn (country code and number) to send to. (Remember to + include countrycode in all numbers, e.g. 4512345678). + + If max length is exceeded, the entire api call will fail. + maxLength: 20 + minLength: 0 + example: '4512345678' + countryHint: + type: string + description: >- + For optimal phone number validation, we encourage you to provide us + with a country code. This can be the numeric country code (like 44) + or the two-letter suffix (like GB). If this field is empty it is + important that you add the country code (e.g 44) in front of the + phone number in “to”. + maxLength: 50 + minLength: 0 + example: '45' + messageId: + type: string + description: >- + An optional message id used to identify the message. + + If no message id is provided, a new message id is generated and + assigned to the message. This id must be unique across all messages + created on the same account. + + (In case a previous message has been deleted according to GDPR + deletion rules setup on the specific account, the messageId is + allowed to be reused) + + If max length is exceeded, the entire api call will fail. + maxLength: 50 + minLength: 1 + example: PetShop + respectBlacklist: + type: boolean + description: >- + If true, this message will be blocked from sending if the target + number is on the account's blacklist. If false, the message will be + sent no matter blacklist settings. + + Default: true + nullable: true + example: true + validityPeriodInSeconds: + type: integer + description: >- + The validity period in seconds. Minimum is 60 seconds and maximum is + 172800 (48 hours). + + If not specified, the messages is attempted to be delivered in 48 + hours. A typical use of validityPeriod is for messages that makes no + sense to delivery efter er certain time frame, in the case the phone + is turned of, e.g. two factor codes. + + Please note, that messages are still charged even though the + operator is cancelling the delivery attempt due to an exceeded + validity period. + format: int32 + maximum: 172800 + minimum: 60 + nullable: true + example: 90 + statusCallbackUrl: + type: string + description: >- + In case you would like a callback from us when the message is + delivered, you can specify it here and we will call it when we have + new message statuses. + + The callback payload will be an array of status objects. + + Api calls sending messages with the same apikey will be subject to + being bulked together. + maxLength: 500 + minLength: 0 + example: https://[your_domain]/your/desired/path + sendTime: + type: string + description: >- + If set, this defines to time in the future for the message to be + sent. e.g. 2001-02-30T14:50:23Z (UTC time). + example: '2001-02-30T14:50:23Z' + msisdnCooldownInMinutes: + type: integer + description: >- + If set, the message will be cancelled if the same mobile number + already have received a SMS within this specified time period. + + Fx. used to prevent spamming a mobile number. + + Minimum 60 minutes (1 hour) and maximum is 43200 minutes (30 days). + format: int32 + maximum: 43200 + minimum: 60 + nullable: true + example: 1440 + StatusReportListModel: + type: object + additionalProperties: false + properties: + reports: + type: array + items: + $ref: '#/components/schemas/StatusReport' + StatusReport: + type: object + additionalProperties: false + properties: + messageId: + type: string + description: The id of the message. + example: id1 + numberDetails: + $ref: '#/components/schemas/StatusReportNumberDetails' + deliveryInfo: + $ref: '#/components/schemas/DeliveryInfo' + chargeInfo: + $ref: '#/components/schemas/ChargeInfo' + StatusReportNumberDetails: + allOf: + - $ref: '#/components/schemas/NumberDetails' + - type: object + additionalProperties: false + properties: + isAnonymized: + type: boolean + description: Specifies whether the message has been anonymized or not. + example: false + DeliveryInfo: + type: object + additionalProperties: false + properties: + stateCode: + description: >- + Contains a code indicating whether a message is delivered, failed or + cancelled. + example: -1 + oneOf: + - $ref: '#/components/schemas/MessageStateCode' + stateDescription: + type: string + description: A text description of the state code + example: Failed + sendTime: + type: string + description: When the message was sent e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + doneTime: + type: string + description: >- + When the delivery of the message fails, is cancelled, or is + delivered. If the operator does not support reporting the actual + delivery time, this will be the time when the delivery report is + received from the operator. + + In some cases where the message is not sent, this value can be null. + example: '2001-02-30T14:50:23Z' + errorCode: + $ref: '#/components/schemas/ErrorCode' + errorDescription: + type: string + description: A text description of the error code + example: Undeliverable message + MessageStateCode: + type: integer + description: |- + 0 = Unknown + 1 = Delivered + -2 = Cancelled + -1 = Failed + x-enumNames: + - Unknown + - Delivered + - Cancelled + - Failed + enum: + - 0 + - 1 + - -2 + - -1 + ErrorCode: + type: integer + description: "A code describing the error if the state is not Delivered. This property will be absent in case the state is Delivered.\n\r-1 = Undeliverable message\n\r-2 = Msisdn blacklisted by operator\n\r-3 = Invalid mobile number\n\r-4 = Country not available\n\r-5 = Delivery timeout\n\r-6 = Not delivered removed from gateway\n\r-8 = Insufficient funds\n\r-9 = Authorize failed\n\r-10 = Capture failed\n\r-11 = Overcharge donation limit exceeded\n\r-12 = Overcharge type not activated\n\r-13 = Overcharge settings not valid\n\r-14 = Sender name blocked\n\r-15 = Route not available\n\r-16 = Refund not available\n\r-17 = Refund not possible for message\n\r-18 = Refund failed\n\r-19 = Refund not possible for pending message\n\r-20 = Refund not possible for failed message\n\r-21 = Refund failed already refunded\n\r-22 = Delivery timeout before sent\n\r-23 = Message queue full at operator\n\r-80 = Imported from other system\n\r-99 = Submit failed\n\r-100 = Communication error\n\r-101 = Unknown id\n\r-102 = Cancelled\n\r-103 = Unknown error processing message\n\r-104 = Unknown id at operator\n\r-105 = Msisdn blacklisted on account\n\r-106 = Mobile number cooldown\n\r-201 = Suspicious sms content\n\r-202 = Account deactivated\n\r-300 = Pdu sequence incomplete\n\r-301 = Pdu sequence invalid\n\r" + format: integer + example: -1 + ChargeInfo: + type: object + additionalProperties: false + properties: + isCharged: + type: boolean + description: True if the message will be charged. + example: true + smsCount: + type: integer + description: >- + The total sms count in the message. If IsCharged is true, this is + the number of sms'es that will be charged. + format: int32 + example: 2 + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2". In case + the message was submitted with encoding "auto", this report will + reveal the final encoding based on the characters in the message + text. + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + example: gsm7 + SmsOutgoingTemplatePostReply: + type: object + additionalProperties: false + properties: + usedPlaceholderKeys: + type: array + description: A list of used used placeholder keys + example: + - '{name}' + - '{lastname}' + items: + type: string + notUsedPlaceholderKeys: + type: array + description: A list of not used placeholder keys + example: + - '{name}' + - '{lastname}' + items: + type: string + results: + type: array + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateResultModel' + SmsOutgoingTemplatePostRequest: + type: object + additionalProperties: false + required: + - templateId + - messages + properties: + templateId: + type: string + description: The id of the template to use + minLength: 1 + example: ecdcb257-c1e9-4b44-8a4e-f05822372d82 + messages: + type: array + description: >- + A list of the sms messages to be sent. Allowed to contain between 1 + and 250 elements. + maxItems: 250 + minItems: 1 + items: + $ref: '#/components/schemas/SmsOutgoingTemplateApiCreateModel' + SmsOutgoingTemplateApiCreateModel: + allOf: + - $ref: '#/components/schemas/SmsOutgoingBaseApiModel' + - type: object + additionalProperties: false + properties: + placeholders: + description: >- + A key-value list of placeholders to replace in the template + text. Keys must be encapsulated with {}. E.g. {NAME}. + example: + '{name}': Friedhelm + '{lastname}': Hillebrand + oneOf: + - $ref: '#/components/schemas/ApiPlaceholderValueCollection' + SmsOutgoingCancelPostReply: + type: object + additionalProperties: false + properties: + results: + type: array + description: A list of results + items: + $ref: '#/components/schemas/SmsOutgoingCancelPostReplyResultModel' + SmsOutgoingCancelPostReplyResultModel: + type: object + additionalProperties: false + properties: + messageId: + type: string + description: The MessageId of the message that was attempted cancelled. + example: 8fe266b2-56e9-4b5f-938f-cc5e22530721 + resultCode: + description: A value indicating if the message was cancelled. + example: 1 + oneOf: + - $ref: '#/components/schemas/CancelResultCode' + resultDescription: + type: string + description: A description of the result. + example: Success + CancelResultCode: + type: integer + description: |- + 0 = Unknown + 1 = Success + -2 = MessageNotFound + -1 = NotCancelled + x-enumNames: + - Unknown + - Success + - MessageNotFound + - NotCancelled + enum: + - 0 + - 1 + - -2 + - -1 + SmsOutgoingCancelPostRequest: + type: object + additionalProperties: false + required: + - messageIds + properties: + messageIds: + type: array + description: >- + A list of the sms message ids to be cancelled. Allowed to contain + between 1 and 250 elements. + maxItems: 250 + minItems: 1 + example: + - id1 + - id2 + items: + type: string + ApiPageModelOfStandardTextOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfStandardTextOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfStandardTextOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/StandardTextOutputApiModel' + StandardTextOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the template + example: c7114ec3-8f89-4e26-8048-686585c1da2a + name: + type: string + description: The name of the template + example: My template + text: + type: string + description: The template text + example: My template text {name} {lastname} + senderName: + type: string + description: The sendername to use with this template + example: My sendername + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2" + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + example: gsm7 + placeholders: + type: array + description: >- + A list of the placeholders found in the template html, text and + subject. + example: + - '{name}' + - '{lastname}' + items: + type: string + created: + type: string + description: When the template was created e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + lastUpdated: + type: string + description: >- + When the template was last updated e.g. 2001-02-30T14:50:23Z (UTC + time) + example: '2001-02-30T14:50:23Z' + ParsePhoneNumberPostReply: + type: object + additionalProperties: false + properties: + results: + type: array + items: + $ref: '#/components/schemas/NumberDetails' + ParsePhoneNumberPostRequest: + type: object + additionalProperties: false + required: + - numbersToParse + properties: + numbersToParse: + type: array + description: A list of the numbersToParse and country hints to be parsed + minItems: 1 + items: + $ref: '#/components/schemas/RawMsisdnAndCountryHint' + RawMsisdnAndCountryHint: + type: object + additionalProperties: false + properties: + countryHint: + type: string + description: The country part of the msisdn, e.g. 45 or DK. + example: '45' + rawMsisdn: + type: string + description: >- + The input msisdn in its unaltered format. This is the value provided + when sending the text message. + example: +45 12 34 56 78 + securitySchemes: + BasicAuth: + type: http + description: >- + Provide Basic Authentiation with an arbitrary username and your api key + as password, e.g. some_value_to_be_ignored:your_api_key_here + scheme: basic + QueryParameter: + type: apiKey + description: >- + Specify your apikey in the url as + https://api.inmobile.com/some/path?apikey=your_api_key_here. This method + is only recommended if basic authorization is not possible. + name: apikey + in: query +security: + - BasicAuth: [] + - QueryParameter: [] +tags: + - name: Sms - Outgoing + - name: Sms - Incoming + - name: Blacklist + - name: Lists + - name: Gdpr + - name: Email + - name: Email Templates + - name: Templates + - name: Tools diff --git a/sdks/db/custom-request-specs/innoship.io.yaml b/sdks/db/custom-request-specs/innoship.io.yaml new file mode 100644 index 0000000000..73c8ba47f8 --- /dev/null +++ b/sdks/db/custom-request-specs/innoship.io.yaml @@ -0,0 +1,8417 @@ +openapi: 3.0.1 +info: + title: Innoship API + description: Api service implementation (version:6.0.1.503) + termsOfService: https://example.com/terms + contact: + name: Andrei Paul + email: andrei@innoship.ro + license: + name: Use under LICX + url: https://example.com/license + version: v1 +paths: + /api/ClientLocation: + get: + tags: + - ClientLocation + parameters: + - name: countryCode + in: query + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + post: + tags: + - ClientLocation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + text/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + responses: + '200': + description: Success + /api/ClientLocation/{id}: + put: + tags: + - ClientLocation + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + text/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + responses: + '200': + description: Success + delete: + tags: + - ClientLocation + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + get: + tags: + - ClientLocation + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/ClientLocation/Summary: + post: + tags: + - ClientLocation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/LocationFilter' + application/json: + schema: + $ref: '#/components/schemas/LocationFilter' + text/json: + schema: + $ref: '#/components/schemas/LocationFilter' + application/*+json: + schema: + $ref: '#/components/schemas/LocationFilter' + responses: + '200': + description: Success + /api/ClientLocation/Validate: + post: + tags: + - ClientLocation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/LocationDto' + application/json: + schema: + $ref: '#/components/schemas/LocationDto' + text/json: + schema: + $ref: '#/components/schemas/LocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/LocationDto' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/Courier: + post: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + application/json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + text/json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + application/*+json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/Courier/{courierId}: + delete: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - name: force + in: query + schema: + type: boolean + - name: isEmagMarketPlace + in: query + schema: + type: boolean + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/CourierServices: + put: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: applyToAllLocations + in: query + schema: + type: boolean + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + responses: + '200': + description: Success + patch: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: applyToAllLocations + in: query + schema: + type: boolean + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + responses: + '200': + description: Success + /api/Courier/RequestPickup: + post: + tags: + - Courier + summary: Request pickup to courier + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/PickupRequest' + application/json: + schema: + $ref: '#/components/schemas/PickupRequest' + text/json: + schema: + $ref: '#/components/schemas/PickupRequest' + application/*+json: + schema: + $ref: '#/components/schemas/PickupRequest' + responses: + '200': + description: Pickup requested to courier + content: + application/json: + schema: + $ref: '#/components/schemas/PickupResponse' + '400': + description: Unable to request pickup due to errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Courier/All: + get: + tags: + - Courier + summary: Get all couriers + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: List of couriers + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AllCouriersResponse' + '401': + description: Unable to authorize request + /api/Feedback/{from}/{to}: + get: + tags: + - Feedback + parameters: + - name: from + in: path + required: true + schema: + type: string + format: date-time + - name: to + in: path + required: true + schema: + type: string + format: date-time + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/Label/by-courier/{courierId}/awb/{awb}: + get: + tags: + - Label + summary: Gets the label for the specified courier awb number + parameters: + - name: courierId + in: path + description: '' + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: '' + required: true + schema: + type: string + - name: type + in: query + description: '' + schema: + type: string + default: PDF + - name: format + in: query + description: '' + schema: + type: string + default: A6 + - name: includeVoucher + in: query + description: '' + schema: + type: boolean + default: false + - name: useFile + in: query + description: '' + schema: + type: boolean + default: true + - name: skipCache + in: query + description: '' + schema: + type: boolean + default: false + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/by-courier/{courierId}/voucher/{awb}: + get: + tags: + - Label + summary: Gets the voucher label for the specified courier awb number + parameters: + - name: courierId + in: path + description: '' + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: '' + required: true + schema: + type: string + - name: type + in: query + description: '' + schema: + type: string + default: PDF + - name: format + in: query + description: '' + schema: + type: string + default: A6 + - name: useFile + in: query + description: '' + schema: + type: boolean + default: true + - name: skipCache + in: query + description: '' + schema: + type: boolean + default: false + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/by-courier/{courierId}/awb/{awb}/parcel/{barcodes}: + get: + tags: + - Label + summary: Gets the label for the specified courier parcel barcode and order awb + parameters: + - name: courierId + in: path + description: '' + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: '' + required: true + schema: + type: string + - name: barcodes + in: path + description: '' + required: true + schema: + type: string + - name: type + in: query + description: '' + schema: + type: string + default: PDF + - name: format + in: query + description: '' + schema: + type: string + default: A6 + - name: useFile + in: query + description: '' + schema: + type: boolean + default: true + - name: skipCache + in: query + description: '' + schema: + type: boolean + default: false + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/bulk: + post: + tags: + - Label + summary: Create bulk labels operation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + application/json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + text/json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + responses: + '200': + description: Returns OperationId + '400': + description: Unable to create bulk labels operation due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/bulk/{operationId}: + get: + tags: + - Label + summary: Get bulk labels by operationId + parameters: + - name: operationId + in: path + description: '' + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Location/ClientLocations: + get: + tags: + - Location + responses: + '200': + description: Success + /api/Location/FixedLocation/{id}: + get: + tags: + - Location + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: Success + /api/Location/FixedLocations: + get: + tags: + - Location + parameters: + - name: Courier + in: query + schema: + $ref: '#/components/schemas/Courier' + - name: CountryCode + in: query + schema: + type: string + - name: CountyName + in: query + schema: + type: string + - name: LocalityName + in: query + schema: + type: string + - name: FixedLocationType + in: query + schema: + $ref: '#/components/schemas/FixedLocationType' + - name: ShowInactive + in: query + schema: + type: boolean + - name: RestrictionParcelsCount + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeHeight + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeWidth + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeLength + in: query + schema: + type: integer + format: int32 + - name: ExternalLocationId + in: query + schema: + type: string + - name: Latitude + in: query + schema: + type: number + format: double + - name: Longitude + in: query + schema: + type: number + format: double + - name: Radius + in: query + schema: + type: number + format: double + responses: + '200': + description: Success + /api/Location/Countries: + get: + tags: + - Location + responses: + '200': + description: Success + /api/Location/Counties/{countryCode}: + get: + tags: + - Location + parameters: + - name: countryCode + in: path + required: true + schema: + type: string + responses: + '200': + description: Success + /api/Location/Localities/{countyId}: + get: + tags: + - Location + parameters: + - name: countyId + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: Success + /api/Location/Postalcodes/{CountryCode}/{PostalCode}: + get: + tags: + - Location + parameters: + - name: CountryCode + in: path + required: true + schema: + maxLength: 2 + minLength: 2 + pattern: ^[a-z]*$ + type: string + - name: PostalCode + in: path + required: true + schema: + type: string + - name: CourierId + in: query + schema: + type: integer + format: int32 + responses: + '200': + description: Success + content: + text/plain: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + application/json: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + text/json: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + /api/Location/Postalcodes/{LocalityId}: + get: + tags: + - Location + parameters: + - name: LocalityId + in: path + required: true + schema: + type: integer + format: int32 + - name: CourierId + in: query + schema: + type: integer + format: int32 + - name: filter + in: query + schema: + type: string + responses: + '200': + description: Success + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + /api/Location/Postalcodes/Country/{CountryCode}: + get: + tags: + - Location + parameters: + - name: CountryCode + in: path + required: true + schema: + maxLength: 2 + minLength: 2 + pattern: ^[a-z]*$ + type: string + - name: CourierId + in: query + schema: + type: integer + format: int32 + responses: + '200': + description: Success + content: + text/plain: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + application/json: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + text/json: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + /api/Manifest: + post: + tags: + - Manifest + summary: Requests pickup and get manifest id + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/ManifestRequest' + application/json: + schema: + $ref: '#/components/schemas/ManifestRequest' + text/json: + schema: + $ref: '#/components/schemas/ManifestRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ManifestRequest' + responses: + '200': + description: Returns ManifestId + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + get: + tags: + - Manifest + summary: Requests manifest report by id + parameters: + - name: manifestId + in: query + description: '' + schema: + type: integer + format: int64 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns PDF + '400': + description: Unable to process due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Notifications/sendsms: + post: + tags: + - Notifications + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + application/json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + text/json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + responses: + '200': + description: Success + /api/OfflineOrder/Activate: + put: + tags: + - OfflineOrder + summary: Activate Offline Orders + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/OfflineOrder/Edit: + put: + tags: + - OfflineOrder + summary: Edit Offline Orders + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/OfflineOrder/Add: + post: + tags: + - OfflineOrder + summary: Add Offline Orders + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + responses: + '200': + description: Added successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/Order: + post: + tags: + - Order + summary: Creates a new order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Creates an new order in the system + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/simulate: + post: + tags: + - Order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/validate: + post: + tags: + - Order + summary: Validates a new order request + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '201': + description: Creates an new order in the system + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/multiple/simulate: + post: + tags: + - Order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '400': + description: Bad Request + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '401': + description: Unauthorized + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + /api/Order/file: + post: + tags: + - Order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/{courierId}/awb/{awbNo}: + delete: + tags: + - Order + summary: Deletes an existing order + parameters: + - name: courierId + in: path + description: Courier id + required: true + schema: + type: integer + format: int32 + - name: awbNo + in: path + description: AWB number + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '201': + description: Deletes an existing order from the system + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to delete the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateStatus: + post: + tags: + - Order + summary: Updates orders statuses + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateParcels: + post: + tags: + - Order + summary: Create a new order based on the existing one and cancel the original + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + application/json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + text/json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + responses: + '200': + description: Creates an new order in the system + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateCustomAttributes/{courierId}/awb/{awb}: + post: + tags: + - Order + summary: Updates custom attributes + parameters: + - name: courierId + in: path + description: Courier id + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: AWB number + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: object + additionalProperties: + type: string + application/json: + schema: + type: object + additionalProperties: + type: string + text/json: + schema: + type: object + additionalProperties: + type: string + application/*+json: + schema: + type: object + additionalProperties: + type: string + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/by-location/{externalLocationId}/{from}/{to}: + get: + tags: + - Order + summary: Retrieve orders by externalLocationId with dates filter + parameters: + - name: externalLocationId + in: path + description: External Location Id + required: true + schema: + type: string + - name: from + in: path + description: From date + required: true + schema: + type: string + format: date-time + - name: to + in: path + description: To date + required: true + schema: + type: string + format: date-time + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/ReturnAwbInfo/{courierId}/{returnAwb}: + get: + tags: + - Order + parameters: + - name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - name: returnAwb + in: path + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UploadDocuments: + post: + tags: + - Order + summary: UploadDocuments + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + application/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + text/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + responses: + '200': + description: Document uploaded + content: + application/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiResponse' + '400': + description: Unable to upload documents + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Price: + post: + tags: + - Price + summary: Gets the prices for the specified request + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: List of prices for eligible couriers + content: + application/json: + schema: + $ref: '#/components/schemas/PriceResponse' + '400': + description: Unable to get prices due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Track/by-awb/with-return: + post: + tags: + - Track + summary: Track by Order Courier AWB with return info + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/json: + schema: + $ref: '#/components/schemas/TrackRequest' + text/json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TrackRequest' + responses: + '200': + description: Success + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Track/return/by-awb: + post: + tags: + - Track + summary: Track Retrun by Courier AWB + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/json: + schema: + $ref: '#/components/schemas/TrackRequest' + text/json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TrackRequest' + responses: + '200': + description: Success + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Voucher/Create: + post: + tags: + - Voucher + summary: Create Voucher + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + application/json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + text/json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/Voucher/Activate: + post: + tags: + - Voucher + summary: Activate Voucher + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + application/json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + text/json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request +components: + schemas: + ActivateAddress: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + country: + type: string + nullable: true + countryName: + type: string + nullable: true + countyId: + type: integer + format: int32 + nullable: true + localityId: + type: integer + format: int32 + nullable: true + countryId: + type: integer + format: int32 + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + postalCode: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + fixedLocationId: + type: string + nullable: true + fixedLocationName: + type: string + nullable: true + courierFixedLocationId: + type: string + nullable: true + additionalProperties: false + ActivateOrderApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + shipmentDate: + type: string + format: date-time + nullable: true + shipmentDateEnd: + type: string + format: date-time + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/ActivateOrderParcel' + nullable: true + addressFrom: + $ref: '#/components/schemas/ActivateAddress' + addressTo: + $ref: '#/components/schemas/ActivateAddress' + additionalProperties: false + ActivateOrderParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/ActivateOrderParcelSize' + weight: + type: number + format: double + additionalProperties: false + ActivateOrderParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + additionalProperties: false + ActivateVoucherApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + courierShipmentVoucher: + type: string + nullable: true + additionalProperties: false + AllCouriersResponse: + type: object + properties: + courierId: + type: integer + format: int32 + courier: + type: string + nullable: true + courierDisplayName: + type: string + nullable: true + additionalProperties: false + BulkLabelApiRequest: + type: object + properties: + labelType: + $ref: '#/components/schemas/LabelType' + labelFormat: + $ref: '#/components/schemas/LabelFormat' + useFile: + type: boolean + includeVoucher: + type: boolean + awBs: + type: array + items: + $ref: '#/components/schemas/BulkLabelApiRequestItem' + nullable: true + additionalProperties: false + BulkLabelApiRequestItem: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + typeId: + type: integer + format: int32 + courierShipmentId: + type: string + nullable: true + additionalProperties: false + ClientPreferences: + type: object + properties: + preferredLabel: + $ref: '#/components/schemas/LabelFormat' + preferredLocationId: + type: integer + format: int32 + nullable: true + orderColumns: + type: array + items: + type: string + nullable: true + pickupColumns: + type: array + items: + type: string + nullable: true + returnColumns: + type: array + items: + type: string + nullable: true + additionalProperties: false + Courier: + enum: + - Cargus + - DPD + - FanCourier + - GLS + - Nemo + - Sameday + - ExpressOne + - ECont + - TeamCourier + - DHL + - PostaRomana + - PostaPanduri + - GLS_HU + - DragonStar + - Coletaria + - Bookurier + - Asendia + - TNT + - DPD_BG + - GLS_HR + - GLS_CZ + - GLS_SI + - GLS_SK + - InOut + - StackCurier + - GebruderWeiss + - Pallex + - GT + - CourierManager + - GLS_IT + - ECourier + - Unimasters + - TCE + - TransilvaniaPost + - BGPost + - Evropat + - SMPCourier + - DHL_DE + - Raben + - Memex + - PTTExpress + - XDCourier + - IL + - NovaPosta + - PinkPost + - Strongo + - DHL_Paket + - DHL_Parcel + - BeeFast + - InPost + - KLG + - Schenker + - Packageez + - Kargo + - SundayCourier + - PocztaPolska + - Sinapseria + - UPS + - DPD_HR + - DPD_SI + - NovaPoshtaGlobal + - ALD + - ProNatur + - DPD_HU + - GLS_PL + - Futar24h + - SlovakParcelService + - DPD_DE + - VanOnGo + - CeskaPosta + - DPD_SK + - SolAir + - PostaSlovenije + - DPD_PL + - Agil24 + - OrlenPackza + - Speedex + - FedEx + - DPD_UK + - PPL + - EColet + - ACS + - Helpship + - DPD_CZ + - MagyarPosta + - EVRI + - FedEx_PL + - KuehneNagel + - Sameday_BG + - Sameday_HU + - FanDelivery + - Seur + - Correos + - Couriera + - ChopChop + - InPost_ES + - FanCourierMoldova + - GLS_DE + - Kurier123 + - Dachser + - CTT_PT + - DPD_AT + - PostNord + - Pharmalink + - MRW + - Eurolog + - IDLogistics + - GLS_DK + - RoyalMail + - FanInternational + - Go4 + - InPost_IT + - AmazonShipping_IT + - TNT_IT + - Posta_SK + - Posta_AT + - GLS_ES + - LithuanianPost + - DHL_Parcel_DE + - DPD_LT + - ExpressOne_BG + - FoxPost + - Posta_NL + - InnoshipMocked + type: string + CourierServiceRestrictionsDto: + type: object + properties: + piecesCountMin: + type: integer + format: int32 + nullable: true + piecesCountMax: + type: integer + format: int32 + nullable: true + weightMin: + type: integer + format: int32 + nullable: true + weightMax: + type: integer + format: int32 + nullable: true + parcelWeightMin: + type: integer + format: int32 + nullable: true + parcelWeightMax: + type: integer + format: int32 + nullable: true + widthMin: + type: integer + format: int32 + nullable: true + widthMax: + type: integer + format: int32 + nullable: true + heightMin: + type: integer + format: int32 + nullable: true + heightMax: + type: integer + format: int32 + nullable: true + lengthMin: + type: integer + format: int32 + nullable: true + lengthMax: + type: integer + format: int32 + nullable: true + orderCountMax: + type: integer + format: int32 + nullable: true + orderPiecesCountMax: + type: integer + format: int32 + nullable: true + orderLocationCountMax: + type: array + items: + $ref: '#/components/schemas/RestrictionCountryCountyDto' + nullable: true + orderLocationPiecesCountMax: + type: array + items: + $ref: '#/components/schemas/RestrictionCountryCountyDto' + nullable: true + allowsCOD: + type: boolean + nullable: true + allowsBankCOD: + type: boolean + nullable: true + allowsNoSizeForParcels: + type: boolean + nullable: true + allowsPickUp: + type: boolean + nullable: true + allowsOrder: + type: boolean + nullable: true + allowsEmptyPostalCode: + type: boolean + nullable: true + allowsReturnDocument: + type: boolean + nullable: true + allowsReturnPackage: + type: boolean + nullable: true + allowsOversized: + type: boolean + nullable: true + allowsInsurance: + type: boolean + nullable: true + allowsSaturdayDelivery: + type: boolean + nullable: true + allowsOpenPackage: + type: boolean + nullable: true + courierCutOffTime: + type: string + format: date-span + nullable: true + additionalProperties: false + CreateLocationCourierServicesDto: + type: object + properties: + courierId: + type: integer + format: int32 + isEmagMarketPlace: + type: boolean + additionalProperties: false + CreateVoucherApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + voucherCourier: + $ref: '#/components/schemas/Courier' + insuranceAmount: + type: number + format: double + insuranceCurrency: + type: string + nullable: true + additionalProperties: false + EditOrderApiRequest: + type: object + properties: + offlineStatusId: + $ref: '#/components/schemas/OrderOfflineStatus' + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + shipmentDate: + type: string + format: date-time + nullable: true + shipmentDateEnd: + type: string + format: date-time + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/ActivateOrderParcel' + nullable: true + addressFrom: + $ref: '#/components/schemas/ActivateAddress' + addressTo: + $ref: '#/components/schemas/ActivateAddress' + additionalProperties: false + Error: + type: object + properties: + context: + type: string + nullable: true + message: + type: string + nullable: true + details: + type: array + items: + $ref: '#/components/schemas/Error' + nullable: true + additionalProperties: false + ErrorResponse: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorResponseItem' + nullable: true + correlationId: + type: string + nullable: true + additionalProperties: false + ErrorResponseItem: + type: object + properties: + message: + type: string + nullable: true + details: + type: array + items: + type: string + nullable: true + additionalProperties: false + FixedLocationType: + enum: + - Locker + - PickupPoint + type: string + LabelFormat: + enum: + - A4 + - A6 + - T_85x85 + - A6_300dpi + - A4_4xA6 + - A6_10x9 + type: string + LabelResponse: + type: object + properties: + courier: + type: integer + format: int32 + contents: + type: string + nullable: true + labels: + type: array + items: + type: string + nullable: true + additionalProperties: false + LabelType: + enum: + - Pdf + - Html + - Zpl + type: string + LimitedAddress: + type: object + properties: + country: + type: string + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + postalCode: + type: string + nullable: true + additionalProperties: false + LocalityPostalCodeInfo: + type: object + properties: + localityId: + type: integer + format: int32 + postalCode: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNameLocalized: + type: string + nullable: true + neighbourhoodName: + type: string + nullable: true + neighbourhoodNameLocalized: + type: string + nullable: true + streetPrefix: + type: string + nullable: true + streetPrefixLocalized: + type: string + nullable: true + additionalProperties: false + LocationAddressDto: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + postalCode: + type: string + nullable: true + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countryCode: + type: string + nullable: true + countryName: + type: string + nullable: true + ignoreLocalityId: + type: boolean + latitude: + type: number + format: double + nullable: true + longitude: + type: number + format: double + nullable: true + additionalProperties: false + LocationCourierServiceDto: + type: object + properties: + courierId: + type: integer + format: int32 + courier: + type: string + nullable: true + courierDisplayName: + type: string + nullable: true + serviceId: + type: integer + format: int32 + service: + type: string + nullable: true + serviceGroupId: + type: integer + format: int32 + serviceGroupName: + type: string + nullable: true + hasValidationError: + type: boolean + nullable: true + courierServiceRestrictions: + $ref: '#/components/schemas/CourierServiceRestrictionsDto' + useCourierPrices: + type: boolean + nullable: true + mappingTemplateOptionId: + type: string + nullable: true + voucherTemplateOptionId: + type: string + nullable: true + extraServices: + type: object + additionalProperties: + type: boolean + nullable: true + nullable: true + mappingReferences: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + countryDeliveryDays: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + enabled: + type: boolean + nullable: true + localityKm: + type: integer + format: int32 + nullable: true + priceLocalityId: + type: integer + format: int32 + nullable: true + additionalProperties: false + LocationDto: + type: object + properties: + address: + $ref: '#/components/schemas/LocationAddressDto' + courierCutOffTimes: + type: string + nullable: true + courierAutomaticCallTimes: + type: string + nullable: true + useSameCourierForSameAddress: + type: boolean + courierFailPolicy: + type: integer + format: int32 + timeZoneId: + type: string + nullable: true + priceGroupId: + type: integer + format: int32 + nullable: true + notificationEmail: + type: string + nullable: true + notificationPhone: + type: string + nullable: true + courierVoucherService: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + marketPlaceCallBackSettings: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + importIsActive: + type: boolean + nullable: true + setHandoverOnManifest: + type: boolean + nullable: true + courierServices: + type: array + items: + $ref: '#/components/schemas/LocationCourierServiceDto' + nullable: true + id: + type: integer + format: int32 + name: + type: string + nullable: true + externalLocationId: + type: string + nullable: true + additionalProperties: false + LocationFilter: + type: object + properties: + name: + type: array + items: + type: string + nullable: true + countryId: + type: array + items: + type: integer + format: int32 + nullable: true + countyId: + type: array + items: + type: integer + format: int32 + nullable: true + localityId: + type: array + items: + type: integer + format: int32 + nullable: true + addressText: + type: string + nullable: true + courierId: + type: array + items: + type: integer + format: int32 + nullable: true + ids: + type: array + items: + type: integer + format: int32 + nullable: true + createdAtLe: + type: string + format: date-time + nullable: true + createdAtGe: + type: string + format: date-time + nullable: true + userId: + type: array + items: + type: string + format: uuid + nullable: true + skip: + type: integer + format: int32 + nullable: true + take: + type: integer + format: int32 + nullable: true + orderBy: + type: string + nullable: true + orderByAsc: + type: boolean + additionalProperties: false + ManifestRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + externalLocationId: + type: string + nullable: true + lastPickHour: + type: integer + format: int32 + nullable: true + additionalProperties: false + MarketplaceIntegration: + enum: + - Vivre + type: string + OfflineOrderAddParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/OfflineOrderAddParcelSize' + weight: + type: number + format: double + type: + $ref: '#/components/schemas/ParcelType' + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + additionalProperties: false + OfflineOrderAddParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + additionalProperties: false + OfflineOrderAddRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddParcel' + nullable: true + additionalProperties: false + OrderBarcodes: + type: object + properties: + sequenceNo: + type: integer + format: int32 + barcode: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + additionalProperties: false + OrderOfflineStatus: + enum: + - New + - Success + - Error + - InProgress + - Consolidate + type: string + OrderRequest: + type: object + properties: + serviceId: + type: integer + format: int32 + courierId: + $ref: '#/components/schemas/Courier' + shipmentDate: + type: string + format: date-time + shipmentDateEnd: + type: string + format: date-time + addressFrom: + $ref: '#/components/schemas/OrderRequestAddress' + addressTo: + $ref: '#/components/schemas/OrderRequestAddress' + addressReturn: + $ref: '#/components/schemas/OrderRequestAddress' + payment: + $ref: '#/components/schemas/PaymentType' + content: + $ref: '#/components/schemas/OrderRequestContent' + extra: + $ref: '#/components/schemas/OrderRequestExtra' + parameters: + $ref: '#/components/schemas/OrderRequestParameters' + externalClientLocation: + type: string + nullable: true + externalOrderId: + type: string + nullable: true + metadata: + type: string + nullable: true + sourceChannel: + type: string + nullable: true + observation: + type: string + nullable: true + customAttributes: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + clientSettings: + $ref: '#/components/schemas/OrderRequestClientSettings' + additionalProperties: false + OrderRequestAddress: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + country: + type: string + nullable: true + countryName: + type: string + nullable: true + countyId: + type: integer + format: int32 + nullable: true + localityId: + type: integer + format: int32 + nullable: true + countryId: + type: integer + format: int32 + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + streetType: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNumber: + type: string + nullable: true + postalCode: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + fixedLocationId: + type: string + nullable: true + fixedLocationName: + type: string + nullable: true + courierFixedLocationId: + type: string + nullable: true + additionalProperties: false + OrderRequestClientSettings: + type: object + properties: + trackPageDomainName: + type: string + nullable: true + priceWeight: + type: number + format: double + nullable: true + performanceWeight: + type: number + format: double + nullable: true + performanceMaximumPriceDeviation: + type: number + format: double + nullable: true + performanceMaximumFlatPriceDeviation: + type: number + format: double + nullable: true + performancePreferredMinimumPriceThreshold: + type: number + format: double + nullable: true + clientPreferences: + $ref: '#/components/schemas/ClientPreferences' + senderLocationTimeZoneId: + type: string + nullable: true + doNoSaveGDPRData: + type: boolean + nullable: true + openPackageIsOptional: + type: boolean + nullable: true + saturdayDeliveryIsOptional: + type: boolean + nullable: true + uniqueOrderReferenceId: + type: integer + format: int32 + nullable: true + useInnoshipInsurance: + type: boolean + nullable: true + performanceClientRates: + type: object + additionalProperties: + type: number + format: double + nullable: true + additionalProperties: false + OrderRequestContent: + type: object + properties: + envelopeCount: + type: integer + format: int32 + parcelsCount: + type: integer + format: int32 + palettesCount: + type: integer + format: int32 + totalWeight: + type: number + format: double + contents: + type: string + nullable: true + package: + type: string + nullable: true + oversizedPackage: + type: boolean + parcels: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentParcel' + nullable: true + invoiceNumber: + type: string + nullable: true + invoiceDate: + type: string + format: date-time + nullable: true + invoiceValue: + type: number + format: double + nullable: true + invoiceValueCurrency: + type: string + nullable: true + articles: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentArticle' + nullable: true + additionalProperties: false + OrderRequestContentArticle: + type: object + properties: + quantity: + type: integer + format: int32 + description: + type: string + nullable: true + countryOfOrigin: + type: string + nullable: true + tariff: + type: string + nullable: true + weightNet: + type: number + format: double + weightGross: + type: number + format: double + pricePerPieceAmount: + type: number + format: double + pricePerPieceAmountCurrency: + type: string + nullable: true + sku: + type: string + nullable: true + additionalProperties: false + OrderRequestContentParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/OrderRequestContentParcelSize' + weight: + type: number + format: double + type: + $ref: '#/components/schemas/ParcelType' + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + dangerousGood: + $ref: '#/components/schemas/OrderRequestContentParcelDangerousGood' + additionalProperties: false + OrderRequestContentParcelDangerousGood: + type: object + properties: + productId: + type: string + nullable: true + productDescription: + type: string + nullable: true + productClass: + type: integer + format: int32 + quantityClassification: + type: string + nullable: true + packagingGroupType: + type: string + nullable: true + packagingInstructions: + type: string + nullable: true + chemicalRecordIdentifier: + type: string + nullable: true + additionalProperties: false + OrderRequestContentParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + additionalProperties: false + OrderRequestExtra: + type: object + properties: + bankRepaymentAmount: + type: number + format: double + nullable: true + bankRepaymentCurrency: + type: string + nullable: true + cashOnDeliveryAmount: + type: number + format: double + nullable: true + cashOnDeliveryAmountCurrency: + type: string + nullable: true + cashOnDeliveryPayoutToLocation: + type: boolean + nullable: true + declaredValueAmount: + type: number + format: double + nullable: true + declaredValueAmountCurrency: + type: string + nullable: true + openPackage: + type: boolean + nullable: true + saturdayDelivery: + type: boolean + nullable: true + insuranceAmount: + type: number + format: double + nullable: true + insuranceAmountCurrency: + type: string + nullable: true + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + reference4: + type: string + nullable: true + returnOfDocuments: + type: boolean + nullable: true + returnOfDocumentsComment: + type: string + nullable: true + returnPackage: + type: boolean + nullable: true + returnVoucher: + type: boolean + nullable: true + bank: + type: string + nullable: true + bankIBAN: + type: string + nullable: true + bankAccountHolder: + type: string + nullable: true + customsDeclaration: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclaration' + marketPlace: + $ref: '#/components/schemas/MarketplaceIntegration' + uitCode: + type: string + nullable: true + additionalProperties: false + OrderRequestExtraCustomsDeclaration: + type: object + properties: + exporter: + $ref: '#/components/schemas/OrderRequestAddress' + importer: + $ref: '#/components/schemas/OrderRequestAddress' + exporterTaxId: + type: string + nullable: true + exporterEORI: + type: string + nullable: true + exporterBN: + type: string + nullable: true + importerTaxId: + type: string + nullable: true + importerEORI: + type: string + nullable: true + reason: + $ref: '#/components/schemas/PurposeOfShipment' + incoterm: + type: string + nullable: true + attachments: + type: array + items: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclarationAttachment' + nullable: true + additionalProperties: false + OrderRequestExtraCustomsDeclarationAttachment: + type: object + properties: + name: + type: string + nullable: true + content: + type: string + nullable: true + additionalProperties: false + OrderRequestParameters: + type: object + properties: + async: + type: boolean + getParcelsBarcodes: + type: boolean + includeCourierResponse: + type: boolean + includePriceBreakdown: + type: boolean + includeAddressInResponse: + type: boolean + consolidateOrder: + type: boolean + overwriteLocationAddressWithSenderDetails: + type: boolean + additionalProperties: false + OrderResponse: + type: object + properties: + clientOrderId: + type: integer + format: int32 + nullable: true + courierShipmentId: + type: string + nullable: true + courierShipmentVoucher: + type: string + nullable: true + courier: + type: integer + format: int32 + courierParcelsBarcodes: + type: array + items: + $ref: '#/components/schemas/OrderBarcodes' + nullable: true + price: + $ref: '#/components/schemas/OrderResponsePrice' + calculatedDeliveryDate: + type: string + format: date-time + nullable: true + trackPageUrl: + type: string + nullable: true + courierTrackPageUrl: + type: string + nullable: true + courierResponse: + type: object + additionalProperties: {} + nullable: true + extra: + $ref: '#/components/schemas/OrderRequestExtra' + address: + $ref: '#/components/schemas/OrderResponseAddress' + additionalProperties: false + OrderResponseAddress: + type: object + properties: + from: + $ref: '#/components/schemas/LimitedAddress' + to: + $ref: '#/components/schemas/LimitedAddress' + additionalProperties: false + OrderResponsePrice: + type: object + properties: + amount: + type: number + format: double + vat: + type: number + format: double + totalAmount: + type: number + format: double + currency: + type: string + nullable: true + priceComponents: + type: object + properties: + Km: + type: number + format: double + KmFixed: + type: number + format: double + Envelopes: + type: number + format: double + ContentWeight: + type: number + format: double + Insurance: + type: number + format: double + CashOnDelivery: + type: number + format: double + BankRepayment: + type: number + format: double + FixedExtras: + type: number + format: double + Returns: + type: number + format: double + FuelSurcharge: + type: number + format: double + CourierPrice: + type: number + format: double + OpenPackage: + type: number + format: double + SaturdayDelivery: + type: number + format: double + PriceForExtraParcel: + type: number + format: double + ContentWeightZones: + type: number + format: double + ContentWeightPiecesZones: + type: number + format: double + PickupThirdParty: + type: number + format: double + InnoshipInsurance: + type: number + format: double + ReturnDocument: + type: number + format: double + ReturnPackage: + type: number + format: double + PalletType: + type: number + format: double + FuelSurchargeFlat: + type: number + format: double + ParcelsCount: + type: number + format: double + ExtraCharges: + type: number + format: double + HeaviestParcelWeight: + type: number + format: double + WeightAndLDM: + type: number + format: double + ZonePalletType: + type: number + format: double + CountryPalletType: + type: number + format: double + additionalProperties: false + nullable: true + additionalProperties: false + OrderResponseResponseWithErrors: + type: object + properties: + response: + $ref: '#/components/schemas/OrderResponse' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + nullable: true + correlationId: + type: string + nullable: true + additionalProperties: false + ParcelType: + enum: + - Envelope + - Parcel + - Pallet + type: string + PaymentType: + enum: + - Sender + - Recipient + - ThirdParty + type: string + PickupRequest: + type: object + properties: + courierId: + type: integer + format: int32 + locationId: + type: integer + format: int32 + lastPickupHour: + type: integer + format: int32 + lastPickMinute: + type: integer + format: int32 + additionalProperties: false + PickupResponse: + type: object + properties: + success: + type: boolean + message: + type: string + nullable: true + additionalProperties: false + PostalCodeInfo: + type: object + properties: + countryCode: + type: string + nullable: true + countryName: + type: string + nullable: true + postalCode: + type: string + nullable: true + streets: + type: array + items: + $ref: '#/components/schemas/PostalCodeInfoStreet' + nullable: true + additionalProperties: false + PostalCodeInfoStreet: + type: object + properties: + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countryId: + type: integer + format: int32 + countryName: + type: string + nullable: true + streetName: + type: string + nullable: true + group: + type: string + nullable: true + additionalProperties: false + PostalCodeStructured: + type: object + properties: + countryCode: + type: string + nullable: true + countryId: + type: integer + format: int32 + countryName: + type: string + nullable: true + countryNameLocalized: + type: string + nullable: true + counties: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredCounty' + nullable: true + additionalProperties: false + PostalCodeStructuredCounty: + type: object + properties: + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countyNameLocalized: + type: string + nullable: true + localities: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredLocality' + nullable: true + additionalProperties: false + PostalCodeStructuredLocality: + type: object + properties: + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + localityNameLocalized: + type: string + nullable: true + streets: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredStreet' + nullable: true + additionalProperties: false + PostalCodeStructuredStreet: + type: object + properties: + postalCode: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNameLocalized: + type: string + nullable: true + neighbourhood: + type: string + nullable: true + neighbourhoodLocalized: + type: string + nullable: true + group: + type: string + nullable: true + streetPrefix: + type: string + nullable: true + streetPrefixLocalized: + type: string + nullable: true + additionalProperties: false + PriceRate: + type: object + properties: + carrierId: + type: integer + format: int32 + carrier: + type: string + nullable: true + rateAmount: + type: number + format: double + rateVatAmount: + type: number + format: double + rateTotalAmount: + type: number + format: double + readOnly: true + rateCurrency: + type: string + nullable: true + score: + type: number + format: double + performance: + type: number + format: double + calculatedDeliveryDate: + type: string + format: date-time + nullable: true + deliveryDays: + type: integer + format: int32 + serviceId: + type: integer + format: int32 + service: + type: string + nullable: true + priority: + type: integer + format: int32 + priceComponents: + type: object + properties: + Km: + type: number + format: double + KmFixed: + type: number + format: double + Envelopes: + type: number + format: double + ContentWeight: + type: number + format: double + Insurance: + type: number + format: double + CashOnDelivery: + type: number + format: double + BankRepayment: + type: number + format: double + FixedExtras: + type: number + format: double + Returns: + type: number + format: double + FuelSurcharge: + type: number + format: double + CourierPrice: + type: number + format: double + OpenPackage: + type: number + format: double + SaturdayDelivery: + type: number + format: double + PriceForExtraParcel: + type: number + format: double + ContentWeightZones: + type: number + format: double + ContentWeightPiecesZones: + type: number + format: double + PickupThirdParty: + type: number + format: double + InnoshipInsurance: + type: number + format: double + ReturnDocument: + type: number + format: double + ReturnPackage: + type: number + format: double + PalletType: + type: number + format: double + FuelSurchargeFlat: + type: number + format: double + ParcelsCount: + type: number + format: double + ExtraCharges: + type: number + format: double + HeaviestParcelWeight: + type: number + format: double + WeightAndLDM: + type: number + format: double + ZonePalletType: + type: number + format: double + CountryPalletType: + type: number + format: double + additionalProperties: false + nullable: true + additionalProperties: false + PriceResponse: + type: object + properties: + rates: + type: array + items: + $ref: '#/components/schemas/PriceRate' + nullable: true + correlationId: + type: string + nullable: true + additionalProperties: false + PurposeOfShipment: + enum: + - CommercialShipment + - NonCommercialShipment + type: string + RestrictionCountryCountyDto: + type: object + properties: + countryId: + type: integer + format: int32 + countyId: + type: integer + format: int32 + nullable: true + value: + type: integer + format: int32 + additionalProperties: false + SendSmsRequest: + type: object + properties: + campaignName: + type: string + nullable: true + data: + type: array + items: + $ref: '#/components/schemas/SendSmsRequestItem' + nullable: true + additionalProperties: false + SendSmsRequestItem: + type: object + properties: + phone: + type: array + items: + type: string + nullable: true + message: + type: string + nullable: true + additionalProperties: false + TrackRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + awbList: + type: array + items: + type: string + nullable: true + additionalProperties: false + TrackResponseHistory: + type: object + properties: + clientStatusId: + type: integer + format: int32 + clientStatusDescription: + type: string + nullable: true + eventDate: + type: string + format: date-time + isFinalStatus: + type: boolean + localityName: + type: string + nullable: true + additionalProperties: false + TrackResponseWithReturnInfo: + type: object + properties: + returnAwb: + type: string + nullable: true + returnAwbHistory: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + orderId: + type: integer + format: int32 + externalOrderId: + type: string + nullable: true + correlationId: + type: string + nullable: true + courier: + type: integer + format: int32 + shipmentAwb: + type: string + nullable: true + carrierMeasuredWeight: + type: number + format: double + nullable: true + recipientContactName: + type: string + nullable: true + recipientLocality: + type: string + nullable: true + recipientCountryCode: + type: string + nullable: true + trackUrl: + type: string + nullable: true + currentStatus: + type: string + nullable: true + currentStatusId: + type: integer + format: int32 + dispatchId: + type: string + nullable: true + history: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + cashOnDeliveryHistory: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + additionalProperties: false + UpdateLocationCourierServiceDto: + type: object + properties: + courierId: + type: integer + format: int32 + serviceId: + type: integer + format: int32 + courierServiceRestrictions: + $ref: '#/components/schemas/CourierServiceRestrictionsDto' + useCourierPrices: + type: boolean + nullable: true + mappingTemplateOptionId: + type: string + nullable: true + voucherTemplateOptionId: + type: string + nullable: true + extraServices: + type: object + additionalProperties: + type: boolean + nullable: true + nullable: true + mappingReferences: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + countryDeliveryDays: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + enabled: + type: boolean + nullable: true + localityKm: + type: integer + format: int32 + nullable: true + priceLocalityId: + type: integer + format: int32 + nullable: true + additionalProperties: false + UpdateLocationDto: + type: object + properties: + address: + $ref: '#/components/schemas/LocationAddressDto' + courierCutOffTimes: + type: string + nullable: true + courierAutomaticCallTimes: + type: string + nullable: true + useSameCourierForSameAddress: + type: boolean + courierFailPolicy: + type: integer + format: int32 + timeZoneId: + type: string + nullable: true + priceGroupId: + type: integer + format: int32 + nullable: true + notificationEmail: + type: string + nullable: true + notificationPhone: + type: string + nullable: true + courierVoucherService: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + marketPlaceCallBackSettings: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + importIsActive: + type: boolean + nullable: true + setHandoverOnManifest: + type: boolean + nullable: true + id: + type: integer + format: int32 + name: + type: string + nullable: true + externalLocationId: + type: string + nullable: true + additionalProperties: false + UpdateParcelsRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + envelopeCount: + type: integer + format: int32 + parcelsCount: + type: integer + format: int32 + palettesCount: + type: integer + format: int32 + oversizedPackage: + type: boolean + totalWeight: + type: number + format: double + parcels: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentParcel' + nullable: true + parameters: + $ref: '#/components/schemas/OrderRequestParameters' + additionalProperties: false + UpdateStatusRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + typeId: + type: integer + format: int32 + nullable: true + statusId: + type: integer + format: int32 + actionDateTime: + type: string + format: date-time + additionalProperties: false + UploadDocumentsApiRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + attachments: + type: array + items: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclarationAttachment' + nullable: true + additionalProperties: false + UploadDocumentsApiResponse: + type: object + properties: + success: + type: boolean + message: + type: string + nullable: true + additionalProperties: false + securitySchemes: + ApiKeyAuth: + type: apiKey + name: X-Api-Key + in: header +security: + - ApiKeyAuth: + - readAccess + - writeAccess +servers: + - url: https://api.innoship.com diff --git a/sdks/db/fixed-specs-cache/fordefi-fixed-spec.yaml b/sdks/db/fixed-specs-cache/fordefi-fixed-spec.yaml index 7059a5147e..db63436615 100644 --- a/sdks/db/fixed-specs-cache/fordefi-fixed-spec.yaml +++ b/sdks/db/fixed-specs-cache/fordefi-fixed-spec.yaml @@ -4,7 +4,7 @@ publishJson: sdkName: fordefi-{language}-sdk clientName: Fordefi metaDescription: >- - The future of institutional web3 wallets. + The future of institutional web3 wallets. For builders, traders, and operators, Fordefi's comprehensive MPC wallet diff --git a/sdks/db/fixed-specs-cache/ilert-fixed-spec.yaml b/sdks/db/fixed-specs-cache/ilert-fixed-spec.yaml new file mode 100644 index 0000000000..fe24d3a715 --- /dev/null +++ b/sdks/db/fixed-specs-cache/ilert-fixed-spec.yaml @@ -0,0 +1,7290 @@ +publishJson: + company: ilert + serviceName: false + sdkName: ilert-{language}-sdk + clientName: Ilert + metaDescription: >- + ilert is a SaaS company for alerting, on-call management and incident + communication and helps companies to increase their digital uptime. B2C and + B2B companies from across the globe, including well-known brands such as + Bertelsmann, TeamViewer and REWE, trust ilert to empower their operations + teams and ensure everything is running smoothly. + apiStatusUrls: inherit + homepage: ilert.com + developerDocumentation: api.ilert.com/api-docs + categories: + - alerting + - on_call_management + - incident_communication +rawSpecString: | + openapi: 3.0.0 + info: + version: '' + title: ilert REST API + description: >- + + The ilert API is a + [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API + and provides programmatic access to entities in ilert and lets you easily + integrate ilert with 3rd party tools. If you are looking to develop an + inbound integration (e.g. for a monitoring tool), please use our [Events + API](https://api.ilert.com). + + + The API supports the JSON content type for requests and responses. The + response content type is requested via the HTTP Accept header + (`application/json`). All resources are accessible via https and are located + at `api.ilert.com/api`. + + ## Authentication + + The REST API accepts bearer API tokens. Each user may create API keys using + the ilert web application. Note: Make sure to send the `Bearer ` prefix e.g. + `Bearer APIKEY` when sending api key requests. By default, access to all + resources (using any method) requires the client to be authenticated. + + + ## Team Context + When using API tokens, the currently selected team context of the user will not be taken into account, i.e. list results will always return all entities to which the user has a view permission. When using basic auth credentials the currently selected team context of the user will be used to filter resource results. The context may be overwritten for API key calls using the `team-context` HTTP header. Specifying `0` for ALL teams, `-1` for MY teams or a specific team id e.g. `team-context=901` to fetch results for a certain team. + + ## Errors + + ilert uses HTTP response codes to indicate success or failure of an API + request. Codes in the 2xx range indicate success, codes in the 4xx range + indicate a client error (e.g. a missing required parameter) and codes in the + 5xx range indicate an error with ilert's servers. In case of an error, the + response body contains the following information: + + Attribute | Description + ------------- | ------------- + status | the corresponsing HTTP status code + message | a human readable description of the error + code | error code, used to identify error type + + ## API Versioning + + Changes to our API are always backwards-compatible. To get more information + about our API versioning and historical changes, please take a look here. + x-logo: + url: ./ilert-logo-spaced.png + backgroundColor: '#fafafa' + altText: ilert documentation logo + security: + - apiKey: [] + tags: + - name: Numbers + - name: Integrations + - name: Events + - name: Heartbeats + - name: Series + - name: Users + - name: Contacts + - name: Notification Preferences + - name: Escalation Policies + - name: Schedules + - name: Alert Sources + - name: Alerts + - name: Alert Actions + - name: Support Hours + - name: Log-Entries + - name: Notifications + - name: Connectors + - name: Teams + - name: On-Calls + - name: Maintenance Windows + - name: Incident Templates + - name: Services + - name: Service Outages + - name: Automation Rules + - name: Incidents + - name: Metrics + - name: Metric Data Sources + - name: Status Pages + - name: Reports + paths: + /users/{user-id}: + get: + tags: + - Users + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get the specified user. + responses: + '200': + description: the user object + content: + application/json: + schema: + $ref: '#/components/schemas/User' + put: + tags: + - Users + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: the user object + summary: Update an existing user. + responses: + '200': + description: the updated user + content: + application/json: + schema: + $ref: '#/components/schemas/User' + delete: + tags: + - Users + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Delete the specified user. + responses: + '204': + description: if deletion was successful + /users/{user-id}/contacts/emails: + get: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get a user's emails + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactEmail' + post: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmailPost' + required: true + summary: Create a new email + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmail' + /users/{user-id}/contacts/emails/{id}: + get: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get a specific email + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmail' + put: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmailPost' + summary: Update a user's email + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmail' + delete: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified email + responses: + '204': + description: if deletion was successful + /users/{user-id}/contacts/phone-numbers: + get: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get a user's phone numbers + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactPhoneNumber' + post: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumberPost' + required: true + summary: Create a phone number + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumber' + /users/{user-id}/contacts/phone-numbers/{id}: + get: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific phone number + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumber' + put: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumberPost' + summary: Update a user's phone number + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumber' + delete: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified phone number + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/alerts: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get alert notification preferences of a user + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationPreferencesAlert' + post: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlertPost' + required: true + summary: Create an alert notification preference + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlert' + /users/{user-id}/notification-preferences/alerts/{id}: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific notification preferences alert + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlert' + put: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlertPost' + summary: Update a user's alert notification preference + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlert' + delete: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified notification preferences alert + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/duties: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get duty notification preferences of a user + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationPreferencesDuty' + post: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDutyPost' + required: true + summary: Create a duty notification preference + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDuty' + /users/{user-id}/notification-preferences/duties/{id}: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific notification preferences duty + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDuty' + put: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDutyPost' + summary: Update a user's duty notification preference + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDuty' + delete: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified notification preferences duty + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/updates: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get update notification preferences of a user + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + post: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdatePost' + required: true + summary: Create an update notification preference + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + /users/{user-id}/notification-preferences/updates/{id}: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific notification preferences update + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + put: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdatePost' + summary: Update a user's update notification preference + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + delete: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified notification preferences update + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/subscriptions: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get subscription notification preferences of a user + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + post: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscriptionPost' + required: true + summary: Create a subscription notification preference + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + /users/{user-id}/notification-preferences/subscriptions/{id}: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific notification preferences subscription + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + put: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscriptionPost' + summary: Update a user's subscription notification preference + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + delete: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified notification preferences subscription + responses: + '204': + description: if deletion was successful + /numbers: + get: + tags: + - Numbers + security: [] + summary: >- + List available phone numbers that ilert uses to send voice and SMS + notifications + responses: + '200': + description: List of phone numbers + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OutboundNumber' + /integrations: + get: + tags: + - Integrations + security: [] + parameters: + - $ref: '#/components/parameters/start-index' + - $ref: '#/components/parameters/max-results' + summary: >- + List available inbound and outbound integrations. Note: this resource is + paginated. + responses: + '200': + description: list of integrations + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Integration' + /users: + get: + tags: + - Users + parameters: + - $ref: '#/components/parameters/start-index' + - $ref: '#/components/parameters/max-results' + summary: List existing users. + responses: + '200': + description: list of users + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + post: + tags: + - Users + summary: Create a new user. Requires ADMIN privileges. + description: | + **Sample request** + + ```json + Request URL: https://api.ilert.com/api/users + + { + "firstName": "John", + "lastName": "Doe", + "email": "john@acme.com", + "position": "Software Engineer", + } + ``` + + **Response** + + ````json + { + "id": 2188373, + "firstName": "John", + "lastName": "Doe", + "email": "john@acme.com", + "position": "Software Engineer", + "timezone": "Europe/Berlin", + "language": "de", + "role": "RESPONDER", + } + ```` + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserPost' + description: the user object + responses: + '201': + description: >- + Created. The URI of the created user entity is included in the + Location header and the user object is included in the body. + content: + application/json: + schema: + $ref: '#/components/schemas/User' + /users/current: + get: + tags: + - Users + summary: Get the currently authenticated user. + responses: + '200': + description: user object + content: + application/json: + schema: + $ref: '#/components/schemas/User' + put: + summary: Update the current user. + tags: + - Users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserPost' + description: user object + responses: + '200': + description: the updated user + content: + application/json: + schema: + $ref: '#/components/schemas/User' + /alerts: + post: + tags: + - Alerts + summary: >- + Create alerts with customised parameters without requiring events from + monitoring tools that use our Events API. + description: >- + Escalation of the alert will be based on the alert source's escalation + policy or may be overridden by providing a specific escalation policy or + lastly specific set of responders (users), latter will only notify the + user(s) and will not escalate any further. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManualAlert' + description: the alert + required: true + responses: + '201': + description: the created and freshly escalated alert + content: + application/json: + schema: + $ref: '#/components/schemas/Alert' + get: + tags: + - Alerts + summary: >- + List alerts (optionally matching certain criteria that are specified by + query parameters). + description: >- + **Sample URLs** + + * List only alerts that are either in state `PENDING` or `ACCEPTED`:This is an email to + be sent
+ text: + type: string + description: >- + The text body of the email. If none is provided this will be + generated from the HTML. Max size of 2 MB. + + If max size is exceeded, the entire api call will fail. + example: This is the text version of the email + EmailEventListModel: + type: object + additionalProperties: false + properties: + events: + type: array + items: + $ref: '#/components/schemas/EmailEvent' + EmailEvent: + type: object + additionalProperties: false + properties: + messageId: + type: string + description: The id of the message. + example: id1 + eventType: + description: Contains a code for what event type the event is. + example: 3 + oneOf: + - $ref: '#/components/schemas/EmailEventType' + eventTypeDescription: + type: string + description: A text description of the event type + example: Delivered + eventTimestamp: + type: string + description: When the event happened e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + EmailEventType: + type: integer + description: |- + 0 = Undefined + 1 = Clicked + 2 = Complained + 3 = Delivered + 4 = Opened + 5 = PermanentFail + 6 = TemporaryFail + 7 = Unsubscribed + 8 = Queued + 9 = Attempt + x-enumNames: + - Undefined + - Clicked + - Complained + - Delivered + - Opened + - PermanentFail + - TemporaryFail + - Unsubscribed + - Queued + - Attempt + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + ApiPageModelOfEmailTemplateOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfEmailTemplateOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfEmailTemplateOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/EmailTemplateOutputApiModel' + EmailTemplateOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the email template + example: c9b6c7a8-aa22-4a59-b6d5-fdbbeced27bc + name: + type: string + description: The name of the email template + example: My email template + html: + type: string + description: The Html of the email template + example: >- +Hello {name} {lastname}. + This is an email to be sent
+ text: + type: string + description: The text version of the Html + example: Hello {name} This is the text version of the email + subject: + type: string + description: The subject of the email template + example: Hello {lastname} This is the subject of the email + preheader: + type: string + description: The preheader of the email + example: This is the preheader of the email + placeholders: + type: array + description: >- + A list of the placeholders found in the template html, text and + subject. + example: + - '{name}' + - '{lastname}' + items: + type: string + created: + type: string + description: >- + When the email template was created e.g. 2001-02-30T14:50:23Z (UTC + time) + example: '2001-02-30T14:50:23Z' + lastUpdated: + type: string + description: >- + When the email template was last updated e.g. 2001-02-30T14:50:23Z + (UTC time) + example: '2001-02-30T14:50:23Z' + RequestDeletionOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The Id of the Deletion request + example: cf97f715-63d4-41df-92a1-34eb87b866b5 + DeletionRequestCreateInfo: + type: object + additionalProperties: false + properties: + numberInfo: + $ref: '#/components/schemas/NumberInfo' + ApiPageModelOfGroupOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfGroupOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfGroupOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/GroupOutputApiModel' + GroupOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the list + format: guid + example: a80e5daa-1bf9-48ca-b67e-ff79eeab1c39 + name: + type: string + description: The name of the list + example: My list + created: + type: string + description: When the list was created e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + GroupInputApiModel: + type: object + additionalProperties: false + properties: + name: + type: string + ApiPageModelOfRecipientOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfRecipientOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfRecipientOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/RecipientOutputApiModel' + RecipientOutputApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the recipient + format: guid + example: 99e0543f-b059-4127-9b50-c42112f19cc9 + listId: + type: string + description: The id of the list that the recipient belongs to + format: guid + example: 4a5f91d5-3aa4-4419-890e-f7b103406dbf + created: + type: string + description: >- + When the recipient was created e.g. 2001-02-30T14:50:23Z (UTC + time) + example: '2001-02-30T14:50:23Z' + RecipientBaseApiModel: + type: object + x-abstract: true + additionalProperties: false + properties: + externalCreated: + type: string + description: >- + When the recipient was created in an external system e.g. + 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + numberInfo: + $ref: '#/components/schemas/NumberInfo' + fields: + description: The fields to update in the given recipient. + example: + firstname: Friedhelm + lastname: Hillebrand + birthday: '1945-04-30' + custom1: Custom1 + custom2: Custom2 + custom3: Custom3 + custom4: Custom4 + custom5: Custom5 + custom6: Custom6 + email: test@test.dk + zipCode: '8000' + address: testroad 12 + companyName: test company + oneOf: + - $ref: '#/components/schemas/RecipientFieldsCollection' + RecipientFieldsCollection: + type: object + additionalProperties: + type: string + RecipientCreateOrUpdateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + RecipientUpdateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + RecipientCreateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + IncomingMessageListModel: + type: object + additionalProperties: false + properties: + messages: + type: array + items: + $ref: '#/components/schemas/IncomingMessage' + IncomingMessage: + type: object + additionalProperties: false + properties: + from: + $ref: '#/components/schemas/IncomingMessageSender' + to: + $ref: '#/components/schemas/IncomingMessageTarget' + text: + type: string + receivedAt: + type: string + example: '2001-02-30T14:50:23Z' + IncomingMessageSender: + type: object + additionalProperties: false + properties: + countryCode: + type: string + phoneNumber: + type: string + rawSource: + type: string + isValidMsisdn: + type: boolean + IncomingMessageTarget: + type: object + additionalProperties: false + properties: + countryCode: + type: string + phoneNumber: + type: string + msisdn: + type: string + SmsOutgoingPostReply: + type: object + additionalProperties: false + properties: + results: + type: array + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateResultModel' + SmsOutgoingApiCreateResultModel: + type: object + additionalProperties: false + properties: + numberDetails: + description: >- + The parsed details about the msisdn provided in the to-field of the + request (msisdn is a number with a countrycode e.g. 4512345678) + oneOf: + - $ref: '#/components/schemas/NumberDetails' + text: + type: string + description: The text message + example: This is a message text to be sent + from: + type: string + description: The sender. + example: PetShop + smsCount: + type: integer + description: >- + The number of sms messages this message will be split into when sent + to the operator. Charging will also be done according to this + number. + format: int32 + example: 1 + messageId: + type: string + description: >- + An optional message id used to identify the message. + + If no message id is provided, a new message id is generated and + assigned to the message. This id must be unique across all messages + created on the same account. + + (In case a previous message has been deleted according to GDPR + deletion rules setup on the specific account, the messageId is + allowed to be reused) + example: PetShop + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2". In case + the message was submitted with encoding "auto", this report will + reveal the final encoding based on the characters in the message + text. + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + example: gsm7 + NumberDetails: + type: object + additionalProperties: false + properties: + countryCode: + type: string + description: The country code part of the msisdn, e.g. 45. + example: '45' + phoneNumber: + type: string + description: The phone number part of the msisdn, e.g. 12345678. + example: '12345678' + rawMsisdn: + type: string + description: >- + The input msisdn in its unaltered format. This is the value provided + when sending the text message. + example: 45 12 34 56 78 + msisdn: + type: string + description: The final cleaned msisdn + example: '4512345678' + isValidMsisdn: + type: boolean + description: True if the input msisdn was valid. + example: true + countryHint: + type: string + description: The country code hint if provided in the request + SmsOutgoingPostRequest: + type: object + additionalProperties: false + required: + - messages + properties: + messages: + type: array + description: >- + A list of the sms messages to be sent. Allowed to contain between 1 + and 250 elements. + maxItems: 250 + minItems: 1 + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateModel' + SmsOutgoingApiCreateModel: + allOf: + - $ref: '#/components/schemas/SmsOutgoingBaseApiModel' + - type: object + additionalProperties: false + required: + - text + - from + properties: + text: + type: string + description: >- + The text message. + + If the max length is exceeded, the message text is truncated and + sent. + maxLength: 10000 + minLength: 1 + example: This is a message text to be sent + from: + type: string + description: >- + The sender. This can either be a 3-11 chars text sender or an up + to 14 digit long sender number. + + If the max length is exceeded, the string is truncated. + minLength: 1 + example: PetShop + flash: + type: boolean + description: >- + If true, the message will be shown as a flash message (also + known as a class0 message) on the target phone. If false, it + will be received as a standard text message. + + Default: false + nullable: true + example: false + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7", "ucs2" or + "auto". + + "gsm7" is the default alfabet for text messages and when using + gsm7, a single sms message can contain 160 characters. If the + length exceeeds 160 characters, the message is actually split up + into parts of 153 characters and charged according to this. + Please note, that a few, specific characters fill up 2 bytes and + count for 2 letters. Ref: + https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along + with smileys. When using this encoding, a single message can + consist of 70 characters. If the message exceeds 70 characters, + the final message is actually split into parts of 67 characters. + + "auto" can be used in case the sender wishes to support + non-roman characters but wants to save the expenses on all the + trafic that only contains gsm characters anyway. + + Default: "gsm7" + example: gsm7 + SmsOutgoingBaseApiModel: + type: object + additionalProperties: false + required: + - to + properties: + to: + type: string + description: >- + The msisdn (country code and number) to send to. (Remember to + include countrycode in all numbers, e.g. 4512345678). + + If max length is exceeded, the entire api call will fail. + maxLength: 20 + minLength: 0 + example: '4512345678' + countryHint: + type: string + description: >- + For optimal phone number validation, we encourage you to provide us + with a country code. This can be the numeric country code (like 44) + or the two-letter suffix (like GB). If this field is empty it is + important that you add the country code (e.g 44) in front of the + phone number in “to”. + maxLength: 50 + minLength: 0 + example: '45' + messageId: + type: string + description: >- + An optional message id used to identify the message. + + If no message id is provided, a new message id is generated and + assigned to the message. This id must be unique across all messages + created on the same account. + + (In case a previous message has been deleted according to GDPR + deletion rules setup on the specific account, the messageId is + allowed to be reused) + + If max length is exceeded, the entire api call will fail. + maxLength: 50 + minLength: 1 + example: PetShop + respectBlacklist: + type: boolean + description: >- + If true, this message will be blocked from sending if the target + number is on the account's blacklist. If false, the message will be + sent no matter blacklist settings. + + Default: true + nullable: true + example: true + validityPeriodInSeconds: + type: integer + description: >- + The validity period in seconds. Minimum is 60 seconds and maximum is + 172800 (48 hours). + + If not specified, the messages is attempted to be delivered in 48 + hours. A typical use of validityPeriod is for messages that makes no + sense to delivery efter er certain time frame, in the case the phone + is turned of, e.g. two factor codes. + + Please note, that messages are still charged even though the + operator is cancelling the delivery attempt due to an exceeded + validity period. + format: int32 + maximum: 172800 + minimum: 60 + nullable: true + example: 90 + statusCallbackUrl: + type: string + description: >- + In case you would like a callback from us when the message is + delivered, you can specify it here and we will call it when we have + new message statuses. + + The callback payload will be an array of status objects. + + Api calls sending messages with the same apikey will be subject to + being bulked together. + maxLength: 500 + minLength: 0 + example: https://[your_domain]/your/desired/path + sendTime: + type: string + description: >- + If set, this defines to time in the future for the message to be + sent. e.g. 2001-02-30T14:50:23Z (UTC time). + example: '2001-02-30T14:50:23Z' + msisdnCooldownInMinutes: + type: integer + description: >- + If set, the message will be cancelled if the same mobile number + already have received a SMS within this specified time period. + + Fx. used to prevent spamming a mobile number. + + Minimum 60 minutes (1 hour) and maximum is 43200 minutes (30 days). + format: int32 + maximum: 43200 + minimum: 60 + nullable: true + example: 1440 + StatusReportListModel: + type: object + additionalProperties: false + properties: + reports: + type: array + items: + $ref: '#/components/schemas/StatusReport' + StatusReport: + type: object + additionalProperties: false + properties: + messageId: + type: string + description: The id of the message. + example: id1 + numberDetails: + $ref: '#/components/schemas/StatusReportNumberDetails' + deliveryInfo: + $ref: '#/components/schemas/DeliveryInfo' + chargeInfo: + $ref: '#/components/schemas/ChargeInfo' + StatusReportNumberDetails: + allOf: + - $ref: '#/components/schemas/NumberDetails' + - type: object + additionalProperties: false + properties: + isAnonymized: + type: boolean + description: Specifies whether the message has been anonymized or not. + example: false + DeliveryInfo: + type: object + additionalProperties: false + properties: + stateCode: + description: >- + Contains a code indicating whether a message is delivered, failed or + cancelled. + example: -1 + oneOf: + - $ref: '#/components/schemas/MessageStateCode' + stateDescription: + type: string + description: A text description of the state code + example: Failed + sendTime: + type: string + description: When the message was sent e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + doneTime: + type: string + description: >- + When the delivery of the message fails, is cancelled, or is + delivered. If the operator does not support reporting the actual + delivery time, this will be the time when the delivery report is + received from the operator. + + In some cases where the message is not sent, this value can be null. + example: '2001-02-30T14:50:23Z' + errorCode: + $ref: '#/components/schemas/ErrorCode' + errorDescription: + type: string + description: A text description of the error code + example: Undeliverable message + MessageStateCode: + type: integer + description: |- + 0 = Unknown + 1 = Delivered + -2 = Cancelled + -1 = Failed + x-enumNames: + - Unknown + - Delivered + - Cancelled + - Failed + enum: + - 0 + - 1 + - -2 + - -1 + ErrorCode: + type: integer + description: "A code describing the error if the state is not Delivered. This property will be absent in case the state is Delivered.\n\r-1 = Undeliverable message\n\r-2 = Msisdn blacklisted by operator\n\r-3 = Invalid mobile number\n\r-4 = Country not available\n\r-5 = Delivery timeout\n\r-6 = Not delivered removed from gateway\n\r-8 = Insufficient funds\n\r-9 = Authorize failed\n\r-10 = Capture failed\n\r-11 = Overcharge donation limit exceeded\n\r-12 = Overcharge type not activated\n\r-13 = Overcharge settings not valid\n\r-14 = Sender name blocked\n\r-15 = Route not available\n\r-16 = Refund not available\n\r-17 = Refund not possible for message\n\r-18 = Refund failed\n\r-19 = Refund not possible for pending message\n\r-20 = Refund not possible for failed message\n\r-21 = Refund failed already refunded\n\r-22 = Delivery timeout before sent\n\r-23 = Message queue full at operator\n\r-80 = Imported from other system\n\r-99 = Submit failed\n\r-100 = Communication error\n\r-101 = Unknown id\n\r-102 = Cancelled\n\r-103 = Unknown error processing message\n\r-104 = Unknown id at operator\n\r-105 = Msisdn blacklisted on account\n\r-106 = Mobile number cooldown\n\r-201 = Suspicious sms content\n\r-202 = Account deactivated\n\r-300 = Pdu sequence incomplete\n\r-301 = Pdu sequence invalid\n\r" + format: integer + example: -1 + ChargeInfo: + type: object + additionalProperties: false + properties: + isCharged: + type: boolean + description: True if the message will be charged. + example: true + smsCount: + type: integer + description: >- + The total sms count in the message. If IsCharged is true, this is + the number of sms'es that will be charged. + format: int32 + example: 2 + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2". In case + the message was submitted with encoding "auto", this report will + reveal the final encoding based on the characters in the message + text. + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + example: gsm7 + SmsOutgoingTemplatePostReply: + type: object + additionalProperties: false + properties: + usedPlaceholderKeys: + type: array + description: A list of used used placeholder keys + example: + - '{name}' + - '{lastname}' + items: + type: string + notUsedPlaceholderKeys: + type: array + description: A list of not used placeholder keys + example: + - '{name}' + - '{lastname}' + items: + type: string + results: + type: array + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateResultModel' + SmsOutgoingTemplatePostRequest: + type: object + additionalProperties: false + required: + - templateId + - messages + properties: + templateId: + type: string + description: The id of the template to use + minLength: 1 + example: ecdcb257-c1e9-4b44-8a4e-f05822372d82 + messages: + type: array + description: >- + A list of the sms messages to be sent. Allowed to contain between 1 + and 250 elements. + maxItems: 250 + minItems: 1 + items: + $ref: '#/components/schemas/SmsOutgoingTemplateApiCreateModel' + SmsOutgoingTemplateApiCreateModel: + allOf: + - $ref: '#/components/schemas/SmsOutgoingBaseApiModel' + - type: object + additionalProperties: false + properties: + placeholders: + description: >- + A key-value list of placeholders to replace in the template + text. Keys must be encapsulated with {}. E.g. {NAME}. + example: + '{name}': Friedhelm + '{lastname}': Hillebrand + oneOf: + - $ref: '#/components/schemas/ApiPlaceholderValueCollection' + SmsOutgoingCancelPostReply: + type: object + additionalProperties: false + properties: + results: + type: array + description: A list of results + items: + $ref: '#/components/schemas/SmsOutgoingCancelPostReplyResultModel' + SmsOutgoingCancelPostReplyResultModel: + type: object + additionalProperties: false + properties: + messageId: + type: string + description: The MessageId of the message that was attempted cancelled. + example: 8fe266b2-56e9-4b5f-938f-cc5e22530721 + resultCode: + description: A value indicating if the message was cancelled. + example: 1 + oneOf: + - $ref: '#/components/schemas/CancelResultCode' + resultDescription: + type: string + description: A description of the result. + example: Success + CancelResultCode: + type: integer + description: |- + 0 = Unknown + 1 = Success + -2 = MessageNotFound + -1 = NotCancelled + x-enumNames: + - Unknown + - Success + - MessageNotFound + - NotCancelled + enum: + - 0 + - 1 + - -2 + - -1 + SmsOutgoingCancelPostRequest: + type: object + additionalProperties: false + required: + - messageIds + properties: + messageIds: + type: array + description: >- + A list of the sms message ids to be cancelled. Allowed to contain + between 1 and 250 elements. + maxItems: 250 + minItems: 1 + example: + - id1 + - id2 + items: + type: string + ApiPageModelOfStandardTextOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfStandardTextOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfStandardTextOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/StandardTextOutputApiModel' + StandardTextOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the template + example: c7114ec3-8f89-4e26-8048-686585c1da2a + name: + type: string + description: The name of the template + example: My template + text: + type: string + description: The template text + example: My template text {name} {lastname} + senderName: + type: string + description: The sendername to use with this template + example: My sendername + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2" + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + example: gsm7 + placeholders: + type: array + description: >- + A list of the placeholders found in the template html, text and + subject. + example: + - '{name}' + - '{lastname}' + items: + type: string + created: + type: string + description: When the template was created e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + lastUpdated: + type: string + description: >- + When the template was last updated e.g. 2001-02-30T14:50:23Z (UTC + time) + example: '2001-02-30T14:50:23Z' + ParsePhoneNumberPostReply: + type: object + additionalProperties: false + properties: + results: + type: array + items: + $ref: '#/components/schemas/NumberDetails' + ParsePhoneNumberPostRequest: + type: object + additionalProperties: false + required: + - numbersToParse + properties: + numbersToParse: + type: array + description: A list of the numbersToParse and country hints to be parsed + minItems: 1 + items: + $ref: '#/components/schemas/RawMsisdnAndCountryHint' + RawMsisdnAndCountryHint: + type: object + additionalProperties: false + properties: + countryHint: + type: string + description: The country part of the msisdn, e.g. 45 or DK. + example: '45' + rawMsisdn: + type: string + description: >- + The input msisdn in its unaltered format. This is the value provided + when sending the text message. + example: +45 12 34 56 78 + securitySchemes: + BasicAuth: + type: http + description: >- + Provide Basic Authentiation with an arbitrary username and your api key + as password, e.g. some_value_to_be_ignored:your_api_key_here + scheme: basic + QueryParameter: + type: apiKey + description: >- + Specify your apikey in the url as + https://api.inmobile.com/some/path?apikey=your_api_key_here. This method + is only recommended if basic authorization is not possible. + name: apikey + in: query + security: + - BasicAuth: [] + - QueryParameter: [] + tags: + - name: Sms - Outgoing + - name: Sms - Incoming + - name: Blacklist + - name: Lists + - name: Gdpr + - name: Email + - name: Email Templates + - name: Templates + - name: Tools +konfigCliVersion: 1.38.34 diff --git a/sdks/db/fixed-specs-cache/innoship-fixed-spec.yaml b/sdks/db/fixed-specs-cache/innoship-fixed-spec.yaml new file mode 100644 index 0000000000..4682995ad9 --- /dev/null +++ b/sdks/db/fixed-specs-cache/innoship-fixed-spec.yaml @@ -0,0 +1,8432 @@ +publishJson: + company: Innoship + serviceName: false + sdkName: innoship-{language}-sdk + clientName: Innoship + metaDescription: "Innoship is the advanced delivery management platform that helps retailers to improve customer experience by streamlining the delivery process. We combined our eCommerce logistics expertise with all the enterprise features you need to master last-mile customer experience. \n\nBacked by Abris Capital Partners, the ESG transformation specialist private equity investor, Innoship is now part of Alsendo group, the leading eCommerce shipping solutions technologies in the CEE region.\n\nFrom checkout and shipping to tracking, returns and analytics, Innoship helps you safely deliver on promises made to your customers. \n\nEffortless integration, hassle-free delivery\n•\tA simple, one-time integration with the Innoship app allows retailers to access any carrier, local or international.\n•\tExternal markets become readily available with seamless connections to hundreds of carriers in 15+ countries." + apiStatusUrls: inherit + homepage: innoship.io + developerDocumentation: api.innoship.io/index.html + categories: + - shipping_api + - logistics_provider + - shipping_integration +rawSpecString: | + openapi: 3.0.1 + info: + title: Innoship API + description: Api service implementation (version:6.0.1.503) + termsOfService: https://example.com/terms + contact: + name: Andrei Paul + email: andrei@innoship.ro + license: + name: Use under LICX + url: https://example.com/license + version: v1 + paths: + /api/ClientLocation: + get: + tags: + - ClientLocation + parameters: + - name: countryCode + in: query + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + post: + tags: + - ClientLocation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + text/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + responses: + '200': + description: Success + /api/ClientLocation/{id}: + put: + tags: + - ClientLocation + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + text/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + responses: + '200': + description: Success + delete: + tags: + - ClientLocation + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + get: + tags: + - ClientLocation + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/ClientLocation/Summary: + post: + tags: + - ClientLocation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/LocationFilter' + application/json: + schema: + $ref: '#/components/schemas/LocationFilter' + text/json: + schema: + $ref: '#/components/schemas/LocationFilter' + application/*+json: + schema: + $ref: '#/components/schemas/LocationFilter' + responses: + '200': + description: Success + /api/ClientLocation/Validate: + post: + tags: + - ClientLocation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/LocationDto' + application/json: + schema: + $ref: '#/components/schemas/LocationDto' + text/json: + schema: + $ref: '#/components/schemas/LocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/LocationDto' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/Courier: + post: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + application/json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + text/json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + application/*+json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/Courier/{courierId}: + delete: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - name: force + in: query + schema: + type: boolean + - name: isEmagMarketPlace + in: query + schema: + type: boolean + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/CourierServices: + put: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: applyToAllLocations + in: query + schema: + type: boolean + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + responses: + '200': + description: Success + patch: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: applyToAllLocations + in: query + schema: + type: boolean + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + responses: + '200': + description: Success + /api/Courier/RequestPickup: + post: + tags: + - Courier + summary: Request pickup to courier + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/PickupRequest' + application/json: + schema: + $ref: '#/components/schemas/PickupRequest' + text/json: + schema: + $ref: '#/components/schemas/PickupRequest' + application/*+json: + schema: + $ref: '#/components/schemas/PickupRequest' + responses: + '200': + description: Pickup requested to courier + content: + application/json: + schema: + $ref: '#/components/schemas/PickupResponse' + '400': + description: Unable to request pickup due to errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Courier/All: + get: + tags: + - Courier + summary: Get all couriers + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: List of couriers + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AllCouriersResponse' + '401': + description: Unable to authorize request + /api/Feedback/{from}/{to}: + get: + tags: + - Feedback + parameters: + - name: from + in: path + required: true + schema: + type: string + format: date-time + - name: to + in: path + required: true + schema: + type: string + format: date-time + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/Label/by-courier/{courierId}/awb/{awb}: + get: + tags: + - Label + summary: Gets the label for the specified courier awb number + parameters: + - name: courierId + in: path + description: '' + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: '' + required: true + schema: + type: string + - name: type + in: query + description: '' + schema: + type: string + default: PDF + - name: format + in: query + description: '' + schema: + type: string + default: A6 + - name: includeVoucher + in: query + description: '' + schema: + type: boolean + default: false + - name: useFile + in: query + description: '' + schema: + type: boolean + default: true + - name: skipCache + in: query + description: '' + schema: + type: boolean + default: false + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/by-courier/{courierId}/voucher/{awb}: + get: + tags: + - Label + summary: Gets the voucher label for the specified courier awb number + parameters: + - name: courierId + in: path + description: '' + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: '' + required: true + schema: + type: string + - name: type + in: query + description: '' + schema: + type: string + default: PDF + - name: format + in: query + description: '' + schema: + type: string + default: A6 + - name: useFile + in: query + description: '' + schema: + type: boolean + default: true + - name: skipCache + in: query + description: '' + schema: + type: boolean + default: false + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/by-courier/{courierId}/awb/{awb}/parcel/{barcodes}: + get: + tags: + - Label + summary: Gets the label for the specified courier parcel barcode and order awb + parameters: + - name: courierId + in: path + description: '' + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: '' + required: true + schema: + type: string + - name: barcodes + in: path + description: '' + required: true + schema: + type: string + - name: type + in: query + description: '' + schema: + type: string + default: PDF + - name: format + in: query + description: '' + schema: + type: string + default: A6 + - name: useFile + in: query + description: '' + schema: + type: boolean + default: true + - name: skipCache + in: query + description: '' + schema: + type: boolean + default: false + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/bulk: + post: + tags: + - Label + summary: Create bulk labels operation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + application/json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + text/json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + responses: + '200': + description: Returns OperationId + '400': + description: Unable to create bulk labels operation due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/bulk/{operationId}: + get: + tags: + - Label + summary: Get bulk labels by operationId + parameters: + - name: operationId + in: path + description: '' + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Location/ClientLocations: + get: + tags: + - Location + responses: + '200': + description: Success + /api/Location/FixedLocation/{id}: + get: + tags: + - Location + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: Success + /api/Location/FixedLocations: + get: + tags: + - Location + parameters: + - name: Courier + in: query + schema: + $ref: '#/components/schemas/Courier' + - name: CountryCode + in: query + schema: + type: string + - name: CountyName + in: query + schema: + type: string + - name: LocalityName + in: query + schema: + type: string + - name: FixedLocationType + in: query + schema: + $ref: '#/components/schemas/FixedLocationType' + - name: ShowInactive + in: query + schema: + type: boolean + - name: RestrictionParcelsCount + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeHeight + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeWidth + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeLength + in: query + schema: + type: integer + format: int32 + - name: ExternalLocationId + in: query + schema: + type: string + - name: Latitude + in: query + schema: + type: number + format: double + - name: Longitude + in: query + schema: + type: number + format: double + - name: Radius + in: query + schema: + type: number + format: double + responses: + '200': + description: Success + /api/Location/Countries: + get: + tags: + - Location + responses: + '200': + description: Success + /api/Location/Counties/{countryCode}: + get: + tags: + - Location + parameters: + - name: countryCode + in: path + required: true + schema: + type: string + responses: + '200': + description: Success + /api/Location/Localities/{countyId}: + get: + tags: + - Location + parameters: + - name: countyId + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: Success + /api/Location/Postalcodes/{CountryCode}/{PostalCode}: + get: + tags: + - Location + parameters: + - name: CountryCode + in: path + required: true + schema: + maxLength: 2 + minLength: 2 + pattern: ^[a-z]*$ + type: string + - name: PostalCode + in: path + required: true + schema: + type: string + - name: CourierId + in: query + schema: + type: integer + format: int32 + responses: + '200': + description: Success + content: + text/plain: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + application/json: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + text/json: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + /api/Location/Postalcodes/{LocalityId}: + get: + tags: + - Location + parameters: + - name: LocalityId + in: path + required: true + schema: + type: integer + format: int32 + - name: CourierId + in: query + schema: + type: integer + format: int32 + - name: filter + in: query + schema: + type: string + responses: + '200': + description: Success + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + /api/Location/Postalcodes/Country/{CountryCode}: + get: + tags: + - Location + parameters: + - name: CountryCode + in: path + required: true + schema: + maxLength: 2 + minLength: 2 + pattern: ^[a-z]*$ + type: string + - name: CourierId + in: query + schema: + type: integer + format: int32 + responses: + '200': + description: Success + content: + text/plain: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + application/json: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + text/json: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + /api/Manifest: + post: + tags: + - Manifest + summary: Requests pickup and get manifest id + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/ManifestRequest' + application/json: + schema: + $ref: '#/components/schemas/ManifestRequest' + text/json: + schema: + $ref: '#/components/schemas/ManifestRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ManifestRequest' + responses: + '200': + description: Returns ManifestId + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + get: + tags: + - Manifest + summary: Requests manifest report by id + parameters: + - name: manifestId + in: query + description: '' + schema: + type: integer + format: int64 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns PDF + '400': + description: Unable to process due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Notifications/sendsms: + post: + tags: + - Notifications + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + application/json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + text/json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + responses: + '200': + description: Success + /api/OfflineOrder/Activate: + put: + tags: + - OfflineOrder + summary: Activate Offline Orders + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/OfflineOrder/Edit: + put: + tags: + - OfflineOrder + summary: Edit Offline Orders + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/OfflineOrder/Add: + post: + tags: + - OfflineOrder + summary: Add Offline Orders + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + responses: + '200': + description: Added successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/Order: + post: + tags: + - Order + summary: Creates a new order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Creates an new order in the system + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/simulate: + post: + tags: + - Order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/validate: + post: + tags: + - Order + summary: Validates a new order request + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '201': + description: Creates an new order in the system + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/multiple/simulate: + post: + tags: + - Order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '400': + description: Bad Request + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '401': + description: Unauthorized + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + /api/Order/file: + post: + tags: + - Order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/{courierId}/awb/{awbNo}: + delete: + tags: + - Order + summary: Deletes an existing order + parameters: + - name: courierId + in: path + description: Courier id + required: true + schema: + type: integer + format: int32 + - name: awbNo + in: path + description: AWB number + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '201': + description: Deletes an existing order from the system + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to delete the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateStatus: + post: + tags: + - Order + summary: Updates orders statuses + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateParcels: + post: + tags: + - Order + summary: Create a new order based on the existing one and cancel the original + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + application/json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + text/json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + responses: + '200': + description: Creates an new order in the system + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateCustomAttributes/{courierId}/awb/{awb}: + post: + tags: + - Order + summary: Updates custom attributes + parameters: + - name: courierId + in: path + description: Courier id + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: AWB number + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: object + additionalProperties: + type: string + application/json: + schema: + type: object + additionalProperties: + type: string + text/json: + schema: + type: object + additionalProperties: + type: string + application/*+json: + schema: + type: object + additionalProperties: + type: string + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/by-location/{externalLocationId}/{from}/{to}: + get: + tags: + - Order + summary: Retrieve orders by externalLocationId with dates filter + parameters: + - name: externalLocationId + in: path + description: External Location Id + required: true + schema: + type: string + - name: from + in: path + description: From date + required: true + schema: + type: string + format: date-time + - name: to + in: path + description: To date + required: true + schema: + type: string + format: date-time + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/ReturnAwbInfo/{courierId}/{returnAwb}: + get: + tags: + - Order + parameters: + - name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - name: returnAwb + in: path + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UploadDocuments: + post: + tags: + - Order + summary: UploadDocuments + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + application/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + text/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + responses: + '200': + description: Document uploaded + content: + application/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiResponse' + '400': + description: Unable to upload documents + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Price: + post: + tags: + - Price + summary: Gets the prices for the specified request + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: List of prices for eligible couriers + content: + application/json: + schema: + $ref: '#/components/schemas/PriceResponse' + '400': + description: Unable to get prices due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Track/by-awb/with-return: + post: + tags: + - Track + summary: Track by Order Courier AWB with return info + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/json: + schema: + $ref: '#/components/schemas/TrackRequest' + text/json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TrackRequest' + responses: + '200': + description: Success + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Track/return/by-awb: + post: + tags: + - Track + summary: Track Retrun by Courier AWB + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/json: + schema: + $ref: '#/components/schemas/TrackRequest' + text/json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TrackRequest' + responses: + '200': + description: Success + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Voucher/Create: + post: + tags: + - Voucher + summary: Create Voucher + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + application/json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + text/json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/Voucher/Activate: + post: + tags: + - Voucher + summary: Activate Voucher + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + application/json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + text/json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + components: + schemas: + ActivateAddress: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + country: + type: string + nullable: true + countryName: + type: string + nullable: true + countyId: + type: integer + format: int32 + nullable: true + localityId: + type: integer + format: int32 + nullable: true + countryId: + type: integer + format: int32 + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + postalCode: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + fixedLocationId: + type: string + nullable: true + fixedLocationName: + type: string + nullable: true + courierFixedLocationId: + type: string + nullable: true + additionalProperties: false + ActivateOrderApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + shipmentDate: + type: string + format: date-time + nullable: true + shipmentDateEnd: + type: string + format: date-time + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/ActivateOrderParcel' + nullable: true + addressFrom: + $ref: '#/components/schemas/ActivateAddress' + addressTo: + $ref: '#/components/schemas/ActivateAddress' + additionalProperties: false + ActivateOrderParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/ActivateOrderParcelSize' + weight: + type: number + format: double + additionalProperties: false + ActivateOrderParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + additionalProperties: false + ActivateVoucherApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + courierShipmentVoucher: + type: string + nullable: true + additionalProperties: false + AllCouriersResponse: + type: object + properties: + courierId: + type: integer + format: int32 + courier: + type: string + nullable: true + courierDisplayName: + type: string + nullable: true + additionalProperties: false + BulkLabelApiRequest: + type: object + properties: + labelType: + $ref: '#/components/schemas/LabelType' + labelFormat: + $ref: '#/components/schemas/LabelFormat' + useFile: + type: boolean + includeVoucher: + type: boolean + awBs: + type: array + items: + $ref: '#/components/schemas/BulkLabelApiRequestItem' + nullable: true + additionalProperties: false + BulkLabelApiRequestItem: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + typeId: + type: integer + format: int32 + courierShipmentId: + type: string + nullable: true + additionalProperties: false + ClientPreferences: + type: object + properties: + preferredLabel: + $ref: '#/components/schemas/LabelFormat' + preferredLocationId: + type: integer + format: int32 + nullable: true + orderColumns: + type: array + items: + type: string + nullable: true + pickupColumns: + type: array + items: + type: string + nullable: true + returnColumns: + type: array + items: + type: string + nullable: true + additionalProperties: false + Courier: + enum: + - Cargus + - DPD + - FanCourier + - GLS + - Nemo + - Sameday + - ExpressOne + - ECont + - TeamCourier + - DHL + - PostaRomana + - PostaPanduri + - GLS_HU + - DragonStar + - Coletaria + - Bookurier + - Asendia + - TNT + - DPD_BG + - GLS_HR + - GLS_CZ + - GLS_SI + - GLS_SK + - InOut + - StackCurier + - GebruderWeiss + - Pallex + - GT + - CourierManager + - GLS_IT + - ECourier + - Unimasters + - TCE + - TransilvaniaPost + - BGPost + - Evropat + - SMPCourier + - DHL_DE + - Raben + - Memex + - PTTExpress + - XDCourier + - IL + - NovaPosta + - PinkPost + - Strongo + - DHL_Paket + - DHL_Parcel + - BeeFast + - InPost + - KLG + - Schenker + - Packageez + - Kargo + - SundayCourier + - PocztaPolska + - Sinapseria + - UPS + - DPD_HR + - DPD_SI + - NovaPoshtaGlobal + - ALD + - ProNatur + - DPD_HU + - GLS_PL + - Futar24h + - SlovakParcelService + - DPD_DE + - VanOnGo + - CeskaPosta + - DPD_SK + - SolAir + - PostaSlovenije + - DPD_PL + - Agil24 + - OrlenPackza + - Speedex + - FedEx + - DPD_UK + - PPL + - EColet + - ACS + - Helpship + - DPD_CZ + - MagyarPosta + - EVRI + - FedEx_PL + - KuehneNagel + - Sameday_BG + - Sameday_HU + - FanDelivery + - Seur + - Correos + - Couriera + - ChopChop + - InPost_ES + - FanCourierMoldova + - GLS_DE + - Kurier123 + - Dachser + - CTT_PT + - DPD_AT + - PostNord + - Pharmalink + - MRW + - Eurolog + - IDLogistics + - GLS_DK + - RoyalMail + - FanInternational + - Go4 + - InPost_IT + - AmazonShipping_IT + - TNT_IT + - Posta_SK + - Posta_AT + - GLS_ES + - LithuanianPost + - DHL_Parcel_DE + - DPD_LT + - ExpressOne_BG + - FoxPost + - Posta_NL + - InnoshipMocked + type: string + CourierServiceRestrictionsDto: + type: object + properties: + piecesCountMin: + type: integer + format: int32 + nullable: true + piecesCountMax: + type: integer + format: int32 + nullable: true + weightMin: + type: integer + format: int32 + nullable: true + weightMax: + type: integer + format: int32 + nullable: true + parcelWeightMin: + type: integer + format: int32 + nullable: true + parcelWeightMax: + type: integer + format: int32 + nullable: true + widthMin: + type: integer + format: int32 + nullable: true + widthMax: + type: integer + format: int32 + nullable: true + heightMin: + type: integer + format: int32 + nullable: true + heightMax: + type: integer + format: int32 + nullable: true + lengthMin: + type: integer + format: int32 + nullable: true + lengthMax: + type: integer + format: int32 + nullable: true + orderCountMax: + type: integer + format: int32 + nullable: true + orderPiecesCountMax: + type: integer + format: int32 + nullable: true + orderLocationCountMax: + type: array + items: + $ref: '#/components/schemas/RestrictionCountryCountyDto' + nullable: true + orderLocationPiecesCountMax: + type: array + items: + $ref: '#/components/schemas/RestrictionCountryCountyDto' + nullable: true + allowsCOD: + type: boolean + nullable: true + allowsBankCOD: + type: boolean + nullable: true + allowsNoSizeForParcels: + type: boolean + nullable: true + allowsPickUp: + type: boolean + nullable: true + allowsOrder: + type: boolean + nullable: true + allowsEmptyPostalCode: + type: boolean + nullable: true + allowsReturnDocument: + type: boolean + nullable: true + allowsReturnPackage: + type: boolean + nullable: true + allowsOversized: + type: boolean + nullable: true + allowsInsurance: + type: boolean + nullable: true + allowsSaturdayDelivery: + type: boolean + nullable: true + allowsOpenPackage: + type: boolean + nullable: true + courierCutOffTime: + type: string + format: date-span + nullable: true + additionalProperties: false + CreateLocationCourierServicesDto: + type: object + properties: + courierId: + type: integer + format: int32 + isEmagMarketPlace: + type: boolean + additionalProperties: false + CreateVoucherApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + voucherCourier: + $ref: '#/components/schemas/Courier' + insuranceAmount: + type: number + format: double + insuranceCurrency: + type: string + nullable: true + additionalProperties: false + EditOrderApiRequest: + type: object + properties: + offlineStatusId: + $ref: '#/components/schemas/OrderOfflineStatus' + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + shipmentDate: + type: string + format: date-time + nullable: true + shipmentDateEnd: + type: string + format: date-time + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/ActivateOrderParcel' + nullable: true + addressFrom: + $ref: '#/components/schemas/ActivateAddress' + addressTo: + $ref: '#/components/schemas/ActivateAddress' + additionalProperties: false + Error: + type: object + properties: + context: + type: string + nullable: true + message: + type: string + nullable: true + details: + type: array + items: + $ref: '#/components/schemas/Error' + nullable: true + additionalProperties: false + ErrorResponse: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorResponseItem' + nullable: true + correlationId: + type: string + nullable: true + additionalProperties: false + ErrorResponseItem: + type: object + properties: + message: + type: string + nullable: true + details: + type: array + items: + type: string + nullable: true + additionalProperties: false + FixedLocationType: + enum: + - Locker + - PickupPoint + type: string + LabelFormat: + enum: + - A4 + - A6 + - T_85x85 + - A6_300dpi + - A4_4xA6 + - A6_10x9 + type: string + LabelResponse: + type: object + properties: + courier: + type: integer + format: int32 + contents: + type: string + nullable: true + labels: + type: array + items: + type: string + nullable: true + additionalProperties: false + LabelType: + enum: + - Pdf + - Html + - Zpl + type: string + LimitedAddress: + type: object + properties: + country: + type: string + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + postalCode: + type: string + nullable: true + additionalProperties: false + LocalityPostalCodeInfo: + type: object + properties: + localityId: + type: integer + format: int32 + postalCode: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNameLocalized: + type: string + nullable: true + neighbourhoodName: + type: string + nullable: true + neighbourhoodNameLocalized: + type: string + nullable: true + streetPrefix: + type: string + nullable: true + streetPrefixLocalized: + type: string + nullable: true + additionalProperties: false + LocationAddressDto: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + postalCode: + type: string + nullable: true + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countryCode: + type: string + nullable: true + countryName: + type: string + nullable: true + ignoreLocalityId: + type: boolean + latitude: + type: number + format: double + nullable: true + longitude: + type: number + format: double + nullable: true + additionalProperties: false + LocationCourierServiceDto: + type: object + properties: + courierId: + type: integer + format: int32 + courier: + type: string + nullable: true + courierDisplayName: + type: string + nullable: true + serviceId: + type: integer + format: int32 + service: + type: string + nullable: true + serviceGroupId: + type: integer + format: int32 + serviceGroupName: + type: string + nullable: true + hasValidationError: + type: boolean + nullable: true + courierServiceRestrictions: + $ref: '#/components/schemas/CourierServiceRestrictionsDto' + useCourierPrices: + type: boolean + nullable: true + mappingTemplateOptionId: + type: string + nullable: true + voucherTemplateOptionId: + type: string + nullable: true + extraServices: + type: object + additionalProperties: + type: boolean + nullable: true + nullable: true + mappingReferences: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + countryDeliveryDays: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + enabled: + type: boolean + nullable: true + localityKm: + type: integer + format: int32 + nullable: true + priceLocalityId: + type: integer + format: int32 + nullable: true + additionalProperties: false + LocationDto: + type: object + properties: + address: + $ref: '#/components/schemas/LocationAddressDto' + courierCutOffTimes: + type: string + nullable: true + courierAutomaticCallTimes: + type: string + nullable: true + useSameCourierForSameAddress: + type: boolean + courierFailPolicy: + type: integer + format: int32 + timeZoneId: + type: string + nullable: true + priceGroupId: + type: integer + format: int32 + nullable: true + notificationEmail: + type: string + nullable: true + notificationPhone: + type: string + nullable: true + courierVoucherService: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + marketPlaceCallBackSettings: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + importIsActive: + type: boolean + nullable: true + setHandoverOnManifest: + type: boolean + nullable: true + courierServices: + type: array + items: + $ref: '#/components/schemas/LocationCourierServiceDto' + nullable: true + id: + type: integer + format: int32 + name: + type: string + nullable: true + externalLocationId: + type: string + nullable: true + additionalProperties: false + LocationFilter: + type: object + properties: + name: + type: array + items: + type: string + nullable: true + countryId: + type: array + items: + type: integer + format: int32 + nullable: true + countyId: + type: array + items: + type: integer + format: int32 + nullable: true + localityId: + type: array + items: + type: integer + format: int32 + nullable: true + addressText: + type: string + nullable: true + courierId: + type: array + items: + type: integer + format: int32 + nullable: true + ids: + type: array + items: + type: integer + format: int32 + nullable: true + createdAtLe: + type: string + format: date-time + nullable: true + createdAtGe: + type: string + format: date-time + nullable: true + userId: + type: array + items: + type: string + format: uuid + nullable: true + skip: + type: integer + format: int32 + nullable: true + take: + type: integer + format: int32 + nullable: true + orderBy: + type: string + nullable: true + orderByAsc: + type: boolean + additionalProperties: false + ManifestRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + externalLocationId: + type: string + nullable: true + lastPickHour: + type: integer + format: int32 + nullable: true + additionalProperties: false + MarketplaceIntegration: + enum: + - Vivre + type: string + OfflineOrderAddParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/OfflineOrderAddParcelSize' + weight: + type: number + format: double + type: + $ref: '#/components/schemas/ParcelType' + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + additionalProperties: false + OfflineOrderAddParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + additionalProperties: false + OfflineOrderAddRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddParcel' + nullable: true + additionalProperties: false + OrderBarcodes: + type: object + properties: + sequenceNo: + type: integer + format: int32 + barcode: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + additionalProperties: false + OrderOfflineStatus: + enum: + - New + - Success + - Error + - InProgress + - Consolidate + type: string + OrderRequest: + type: object + properties: + serviceId: + type: integer + format: int32 + courierId: + $ref: '#/components/schemas/Courier' + shipmentDate: + type: string + format: date-time + shipmentDateEnd: + type: string + format: date-time + addressFrom: + $ref: '#/components/schemas/OrderRequestAddress' + addressTo: + $ref: '#/components/schemas/OrderRequestAddress' + addressReturn: + $ref: '#/components/schemas/OrderRequestAddress' + payment: + $ref: '#/components/schemas/PaymentType' + content: + $ref: '#/components/schemas/OrderRequestContent' + extra: + $ref: '#/components/schemas/OrderRequestExtra' + parameters: + $ref: '#/components/schemas/OrderRequestParameters' + externalClientLocation: + type: string + nullable: true + externalOrderId: + type: string + nullable: true + metadata: + type: string + nullable: true + sourceChannel: + type: string + nullable: true + observation: + type: string + nullable: true + customAttributes: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + clientSettings: + $ref: '#/components/schemas/OrderRequestClientSettings' + additionalProperties: false + OrderRequestAddress: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + country: + type: string + nullable: true + countryName: + type: string + nullable: true + countyId: + type: integer + format: int32 + nullable: true + localityId: + type: integer + format: int32 + nullable: true + countryId: + type: integer + format: int32 + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + streetType: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNumber: + type: string + nullable: true + postalCode: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + fixedLocationId: + type: string + nullable: true + fixedLocationName: + type: string + nullable: true + courierFixedLocationId: + type: string + nullable: true + additionalProperties: false + OrderRequestClientSettings: + type: object + properties: + trackPageDomainName: + type: string + nullable: true + priceWeight: + type: number + format: double + nullable: true + performanceWeight: + type: number + format: double + nullable: true + performanceMaximumPriceDeviation: + type: number + format: double + nullable: true + performanceMaximumFlatPriceDeviation: + type: number + format: double + nullable: true + performancePreferredMinimumPriceThreshold: + type: number + format: double + nullable: true + clientPreferences: + $ref: '#/components/schemas/ClientPreferences' + senderLocationTimeZoneId: + type: string + nullable: true + doNoSaveGDPRData: + type: boolean + nullable: true + openPackageIsOptional: + type: boolean + nullable: true + saturdayDeliveryIsOptional: + type: boolean + nullable: true + uniqueOrderReferenceId: + type: integer + format: int32 + nullable: true + useInnoshipInsurance: + type: boolean + nullable: true + performanceClientRates: + type: object + additionalProperties: + type: number + format: double + nullable: true + additionalProperties: false + OrderRequestContent: + type: object + properties: + envelopeCount: + type: integer + format: int32 + parcelsCount: + type: integer + format: int32 + palettesCount: + type: integer + format: int32 + totalWeight: + type: number + format: double + contents: + type: string + nullable: true + package: + type: string + nullable: true + oversizedPackage: + type: boolean + parcels: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentParcel' + nullable: true + invoiceNumber: + type: string + nullable: true + invoiceDate: + type: string + format: date-time + nullable: true + invoiceValue: + type: number + format: double + nullable: true + invoiceValueCurrency: + type: string + nullable: true + articles: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentArticle' + nullable: true + additionalProperties: false + OrderRequestContentArticle: + type: object + properties: + quantity: + type: integer + format: int32 + description: + type: string + nullable: true + countryOfOrigin: + type: string + nullable: true + tariff: + type: string + nullable: true + weightNet: + type: number + format: double + weightGross: + type: number + format: double + pricePerPieceAmount: + type: number + format: double + pricePerPieceAmountCurrency: + type: string + nullable: true + sku: + type: string + nullable: true + additionalProperties: false + OrderRequestContentParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/OrderRequestContentParcelSize' + weight: + type: number + format: double + type: + $ref: '#/components/schemas/ParcelType' + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + dangerousGood: + $ref: '#/components/schemas/OrderRequestContentParcelDangerousGood' + additionalProperties: false + OrderRequestContentParcelDangerousGood: + type: object + properties: + productId: + type: string + nullable: true + productDescription: + type: string + nullable: true + productClass: + type: integer + format: int32 + quantityClassification: + type: string + nullable: true + packagingGroupType: + type: string + nullable: true + packagingInstructions: + type: string + nullable: true + chemicalRecordIdentifier: + type: string + nullable: true + additionalProperties: false + OrderRequestContentParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + additionalProperties: false + OrderRequestExtra: + type: object + properties: + bankRepaymentAmount: + type: number + format: double + nullable: true + bankRepaymentCurrency: + type: string + nullable: true + cashOnDeliveryAmount: + type: number + format: double + nullable: true + cashOnDeliveryAmountCurrency: + type: string + nullable: true + cashOnDeliveryPayoutToLocation: + type: boolean + nullable: true + declaredValueAmount: + type: number + format: double + nullable: true + declaredValueAmountCurrency: + type: string + nullable: true + openPackage: + type: boolean + nullable: true + saturdayDelivery: + type: boolean + nullable: true + insuranceAmount: + type: number + format: double + nullable: true + insuranceAmountCurrency: + type: string + nullable: true + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + reference4: + type: string + nullable: true + returnOfDocuments: + type: boolean + nullable: true + returnOfDocumentsComment: + type: string + nullable: true + returnPackage: + type: boolean + nullable: true + returnVoucher: + type: boolean + nullable: true + bank: + type: string + nullable: true + bankIBAN: + type: string + nullable: true + bankAccountHolder: + type: string + nullable: true + customsDeclaration: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclaration' + marketPlace: + $ref: '#/components/schemas/MarketplaceIntegration' + uitCode: + type: string + nullable: true + additionalProperties: false + OrderRequestExtraCustomsDeclaration: + type: object + properties: + exporter: + $ref: '#/components/schemas/OrderRequestAddress' + importer: + $ref: '#/components/schemas/OrderRequestAddress' + exporterTaxId: + type: string + nullable: true + exporterEORI: + type: string + nullable: true + exporterBN: + type: string + nullable: true + importerTaxId: + type: string + nullable: true + importerEORI: + type: string + nullable: true + reason: + $ref: '#/components/schemas/PurposeOfShipment' + incoterm: + type: string + nullable: true + attachments: + type: array + items: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclarationAttachment' + nullable: true + additionalProperties: false + OrderRequestExtraCustomsDeclarationAttachment: + type: object + properties: + name: + type: string + nullable: true + content: + type: string + nullable: true + additionalProperties: false + OrderRequestParameters: + type: object + properties: + async: + type: boolean + getParcelsBarcodes: + type: boolean + includeCourierResponse: + type: boolean + includePriceBreakdown: + type: boolean + includeAddressInResponse: + type: boolean + consolidateOrder: + type: boolean + overwriteLocationAddressWithSenderDetails: + type: boolean + additionalProperties: false + OrderResponse: + type: object + properties: + clientOrderId: + type: integer + format: int32 + nullable: true + courierShipmentId: + type: string + nullable: true + courierShipmentVoucher: + type: string + nullable: true + courier: + type: integer + format: int32 + courierParcelsBarcodes: + type: array + items: + $ref: '#/components/schemas/OrderBarcodes' + nullable: true + price: + $ref: '#/components/schemas/OrderResponsePrice' + calculatedDeliveryDate: + type: string + format: date-time + nullable: true + trackPageUrl: + type: string + nullable: true + courierTrackPageUrl: + type: string + nullable: true + courierResponse: + type: object + additionalProperties: {} + nullable: true + extra: + $ref: '#/components/schemas/OrderRequestExtra' + address: + $ref: '#/components/schemas/OrderResponseAddress' + additionalProperties: false + OrderResponseAddress: + type: object + properties: + from: + $ref: '#/components/schemas/LimitedAddress' + to: + $ref: '#/components/schemas/LimitedAddress' + additionalProperties: false + OrderResponsePrice: + type: object + properties: + amount: + type: number + format: double + vat: + type: number + format: double + totalAmount: + type: number + format: double + currency: + type: string + nullable: true + priceComponents: + type: object + properties: + Km: + type: number + format: double + KmFixed: + type: number + format: double + Envelopes: + type: number + format: double + ContentWeight: + type: number + format: double + Insurance: + type: number + format: double + CashOnDelivery: + type: number + format: double + BankRepayment: + type: number + format: double + FixedExtras: + type: number + format: double + Returns: + type: number + format: double + FuelSurcharge: + type: number + format: double + CourierPrice: + type: number + format: double + OpenPackage: + type: number + format: double + SaturdayDelivery: + type: number + format: double + PriceForExtraParcel: + type: number + format: double + ContentWeightZones: + type: number + format: double + ContentWeightPiecesZones: + type: number + format: double + PickupThirdParty: + type: number + format: double + InnoshipInsurance: + type: number + format: double + ReturnDocument: + type: number + format: double + ReturnPackage: + type: number + format: double + PalletType: + type: number + format: double + FuelSurchargeFlat: + type: number + format: double + ParcelsCount: + type: number + format: double + ExtraCharges: + type: number + format: double + HeaviestParcelWeight: + type: number + format: double + WeightAndLDM: + type: number + format: double + ZonePalletType: + type: number + format: double + CountryPalletType: + type: number + format: double + additionalProperties: false + nullable: true + additionalProperties: false + OrderResponseResponseWithErrors: + type: object + properties: + response: + $ref: '#/components/schemas/OrderResponse' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + nullable: true + correlationId: + type: string + nullable: true + additionalProperties: false + ParcelType: + enum: + - Envelope + - Parcel + - Pallet + type: string + PaymentType: + enum: + - Sender + - Recipient + - ThirdParty + type: string + PickupRequest: + type: object + properties: + courierId: + type: integer + format: int32 + locationId: + type: integer + format: int32 + lastPickupHour: + type: integer + format: int32 + lastPickMinute: + type: integer + format: int32 + additionalProperties: false + PickupResponse: + type: object + properties: + success: + type: boolean + message: + type: string + nullable: true + additionalProperties: false + PostalCodeInfo: + type: object + properties: + countryCode: + type: string + nullable: true + countryName: + type: string + nullable: true + postalCode: + type: string + nullable: true + streets: + type: array + items: + $ref: '#/components/schemas/PostalCodeInfoStreet' + nullable: true + additionalProperties: false + PostalCodeInfoStreet: + type: object + properties: + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countryId: + type: integer + format: int32 + countryName: + type: string + nullable: true + streetName: + type: string + nullable: true + group: + type: string + nullable: true + additionalProperties: false + PostalCodeStructured: + type: object + properties: + countryCode: + type: string + nullable: true + countryId: + type: integer + format: int32 + countryName: + type: string + nullable: true + countryNameLocalized: + type: string + nullable: true + counties: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredCounty' + nullable: true + additionalProperties: false + PostalCodeStructuredCounty: + type: object + properties: + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countyNameLocalized: + type: string + nullable: true + localities: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredLocality' + nullable: true + additionalProperties: false + PostalCodeStructuredLocality: + type: object + properties: + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + localityNameLocalized: + type: string + nullable: true + streets: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredStreet' + nullable: true + additionalProperties: false + PostalCodeStructuredStreet: + type: object + properties: + postalCode: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNameLocalized: + type: string + nullable: true + neighbourhood: + type: string + nullable: true + neighbourhoodLocalized: + type: string + nullable: true + group: + type: string + nullable: true + streetPrefix: + type: string + nullable: true + streetPrefixLocalized: + type: string + nullable: true + additionalProperties: false + PriceRate: + type: object + properties: + carrierId: + type: integer + format: int32 + carrier: + type: string + nullable: true + rateAmount: + type: number + format: double + rateVatAmount: + type: number + format: double + rateTotalAmount: + type: number + format: double + readOnly: true + rateCurrency: + type: string + nullable: true + score: + type: number + format: double + performance: + type: number + format: double + calculatedDeliveryDate: + type: string + format: date-time + nullable: true + deliveryDays: + type: integer + format: int32 + serviceId: + type: integer + format: int32 + service: + type: string + nullable: true + priority: + type: integer + format: int32 + priceComponents: + type: object + properties: + Km: + type: number + format: double + KmFixed: + type: number + format: double + Envelopes: + type: number + format: double + ContentWeight: + type: number + format: double + Insurance: + type: number + format: double + CashOnDelivery: + type: number + format: double + BankRepayment: + type: number + format: double + FixedExtras: + type: number + format: double + Returns: + type: number + format: double + FuelSurcharge: + type: number + format: double + CourierPrice: + type: number + format: double + OpenPackage: + type: number + format: double + SaturdayDelivery: + type: number + format: double + PriceForExtraParcel: + type: number + format: double + ContentWeightZones: + type: number + format: double + ContentWeightPiecesZones: + type: number + format: double + PickupThirdParty: + type: number + format: double + InnoshipInsurance: + type: number + format: double + ReturnDocument: + type: number + format: double + ReturnPackage: + type: number + format: double + PalletType: + type: number + format: double + FuelSurchargeFlat: + type: number + format: double + ParcelsCount: + type: number + format: double + ExtraCharges: + type: number + format: double + HeaviestParcelWeight: + type: number + format: double + WeightAndLDM: + type: number + format: double + ZonePalletType: + type: number + format: double + CountryPalletType: + type: number + format: double + additionalProperties: false + nullable: true + additionalProperties: false + PriceResponse: + type: object + properties: + rates: + type: array + items: + $ref: '#/components/schemas/PriceRate' + nullable: true + correlationId: + type: string + nullable: true + additionalProperties: false + PurposeOfShipment: + enum: + - CommercialShipment + - NonCommercialShipment + type: string + RestrictionCountryCountyDto: + type: object + properties: + countryId: + type: integer + format: int32 + countyId: + type: integer + format: int32 + nullable: true + value: + type: integer + format: int32 + additionalProperties: false + SendSmsRequest: + type: object + properties: + campaignName: + type: string + nullable: true + data: + type: array + items: + $ref: '#/components/schemas/SendSmsRequestItem' + nullable: true + additionalProperties: false + SendSmsRequestItem: + type: object + properties: + phone: + type: array + items: + type: string + nullable: true + message: + type: string + nullable: true + additionalProperties: false + TrackRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + awbList: + type: array + items: + type: string + nullable: true + additionalProperties: false + TrackResponseHistory: + type: object + properties: + clientStatusId: + type: integer + format: int32 + clientStatusDescription: + type: string + nullable: true + eventDate: + type: string + format: date-time + isFinalStatus: + type: boolean + localityName: + type: string + nullable: true + additionalProperties: false + TrackResponseWithReturnInfo: + type: object + properties: + returnAwb: + type: string + nullable: true + returnAwbHistory: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + orderId: + type: integer + format: int32 + externalOrderId: + type: string + nullable: true + correlationId: + type: string + nullable: true + courier: + type: integer + format: int32 + shipmentAwb: + type: string + nullable: true + carrierMeasuredWeight: + type: number + format: double + nullable: true + recipientContactName: + type: string + nullable: true + recipientLocality: + type: string + nullable: true + recipientCountryCode: + type: string + nullable: true + trackUrl: + type: string + nullable: true + currentStatus: + type: string + nullable: true + currentStatusId: + type: integer + format: int32 + dispatchId: + type: string + nullable: true + history: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + cashOnDeliveryHistory: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + additionalProperties: false + UpdateLocationCourierServiceDto: + type: object + properties: + courierId: + type: integer + format: int32 + serviceId: + type: integer + format: int32 + courierServiceRestrictions: + $ref: '#/components/schemas/CourierServiceRestrictionsDto' + useCourierPrices: + type: boolean + nullable: true + mappingTemplateOptionId: + type: string + nullable: true + voucherTemplateOptionId: + type: string + nullable: true + extraServices: + type: object + additionalProperties: + type: boolean + nullable: true + nullable: true + mappingReferences: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + countryDeliveryDays: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + enabled: + type: boolean + nullable: true + localityKm: + type: integer + format: int32 + nullable: true + priceLocalityId: + type: integer + format: int32 + nullable: true + additionalProperties: false + UpdateLocationDto: + type: object + properties: + address: + $ref: '#/components/schemas/LocationAddressDto' + courierCutOffTimes: + type: string + nullable: true + courierAutomaticCallTimes: + type: string + nullable: true + useSameCourierForSameAddress: + type: boolean + courierFailPolicy: + type: integer + format: int32 + timeZoneId: + type: string + nullable: true + priceGroupId: + type: integer + format: int32 + nullable: true + notificationEmail: + type: string + nullable: true + notificationPhone: + type: string + nullable: true + courierVoucherService: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + marketPlaceCallBackSettings: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + importIsActive: + type: boolean + nullable: true + setHandoverOnManifest: + type: boolean + nullable: true + id: + type: integer + format: int32 + name: + type: string + nullable: true + externalLocationId: + type: string + nullable: true + additionalProperties: false + UpdateParcelsRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + envelopeCount: + type: integer + format: int32 + parcelsCount: + type: integer + format: int32 + palettesCount: + type: integer + format: int32 + oversizedPackage: + type: boolean + totalWeight: + type: number + format: double + parcels: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentParcel' + nullable: true + parameters: + $ref: '#/components/schemas/OrderRequestParameters' + additionalProperties: false + UpdateStatusRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + typeId: + type: integer + format: int32 + nullable: true + statusId: + type: integer + format: int32 + actionDateTime: + type: string + format: date-time + additionalProperties: false + UploadDocumentsApiRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + attachments: + type: array + items: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclarationAttachment' + nullable: true + additionalProperties: false + UploadDocumentsApiResponse: + type: object + properties: + success: + type: boolean + message: + type: string + nullable: true + additionalProperties: false + securitySchemes: + ApiKeyAuth: + type: apiKey + name: X-Api-Key + in: header + security: + - ApiKeyAuth: + - readAccess + - writeAccess + servers: + - url: https://api.innoship.com +konfigCliVersion: 1.38.34 diff --git a/sdks/db/fixed-specs/fordefi-fixed-spec.yaml b/sdks/db/fixed-specs/fordefi-fixed-spec.yaml index 3a94c3b51b..9a53a87616 100644 --- a/sdks/db/fixed-specs/fordefi-fixed-spec.yaml +++ b/sdks/db/fixed-specs/fordefi-fixed-spec.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Fordefi API description: >- - The future of institutional web3 wallets. + The future of institutional web3 wallets. For builders, traders, and operators, Fordefi's comprehensive MPC wallet diff --git a/sdks/db/fixed-specs/ilert-fixed-spec.yaml b/sdks/db/fixed-specs/ilert-fixed-spec.yaml new file mode 100644 index 0000000000..0200e11a31 --- /dev/null +++ b/sdks/db/fixed-specs/ilert-fixed-spec.yaml @@ -0,0 +1,7526 @@ +openapi: 3.0.0 +info: + title: ilert REST API + description: >- + + The ilert API is a + [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API + and provides programmatic access to entities in ilert and lets you easily + integrate ilert with 3rd party tools. If you are looking to develop an + inbound integration (e.g. for a monitoring tool), please use our [Events + API](https://api.ilert.com). + + + The API supports the JSON content type for requests and responses. The + response content type is requested via the HTTP Accept header + (`application/json`). All resources are accessible via https and are located + at `api.ilert.com/api`. + + ## Authentication + + The REST API accepts bearer API tokens. Each user may create API keys using + the ilert web application. Note: Make sure to send the `Bearer ` prefix e.g. + `Bearer APIKEY` when sending api key requests. By default, access to all + resources (using any method) requires the client to be authenticated. + + + ## Team Context + When using API tokens, the currently selected team context of the user will not be taken into account, i.e. list results will always return all entities to which the user has a view permission. When using basic auth credentials the currently selected team context of the user will be used to filter resource results. The context may be overwritten for API key calls using the `team-context` HTTP header. Specifying `0` for ALL teams, `-1` for MY teams or a specific team id e.g. `team-context=901` to fetch results for a certain team. + + ## Errors + + ilert uses HTTP response codes to indicate success or failure of an API + request. Codes in the 2xx range indicate success, codes in the 4xx range + indicate a client error (e.g. a missing required parameter) and codes in the + 5xx range indicate an error with ilert's servers. In case of an error, the + response body contains the following information: + + Attribute | Description + ------------- | ------------- + status | the corresponsing HTTP status code + message | a human readable description of the error + code | error code, used to identify error type + + ## API Versioning + + Changes to our API are always backwards-compatible. To get more information + about our API versioning and historical changes, please take a look here. + version: '' + x-logo: + url: ./ilert-logo-spaced.png + backgroundColor: '#fafafa' + altText: ilert documentation logo + x-konfig-ignore: + object-with-no-properties: true +servers: + - url: /api +tags: + - name: Notification Preferences + - name: Status Pages + - name: Alerts + - name: Contacts + - name: Schedules + - name: Users + - name: Alert Actions + - name: Teams + - name: Services + - name: Incidents + - name: Service Outages + - name: Escalation Policies + - name: Alert Sources + - name: Support Hours + - name: Connectors + - name: Maintenance Windows + - name: Incident Templates + - name: Automation Rules + - name: Metrics + - name: Metric Data Sources + - name: Heartbeats + - name: Reports + - name: Numbers + - name: Integrations + - name: Events + - name: Series + - name: Log-Entries + - name: Notifications + - name: On-Calls +paths: + /users/{user-id}: + get: + tags: + - Users + summary: Get the specified user. + operationId: Users_getUserById + parameters: + - $ref: '#/components/parameters/user-id-in-path' + responses: + '200': + description: the user object + content: + application/json: + schema: + $ref: '#/components/schemas/User' + put: + tags: + - Users + summary: Update an existing user. + operationId: Users_updateExistingUser + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + description: the user object + content: + application/json: + schema: + $ref: '#/components/schemas/User' + responses: + '200': + description: the updated user + content: + application/json: + schema: + $ref: '#/components/schemas/User' + delete: + tags: + - Users + summary: Delete the specified user. + operationId: Users_deleteUser + parameters: + - $ref: '#/components/parameters/user-id-in-path' + responses: + '204': + description: if deletion was successful + /users/{user-id}/contacts/emails: + get: + tags: + - Contacts + summary: Get a user's emails + operationId: Contacts_getUserEmails + parameters: + - $ref: '#/components/parameters/user-id-in-path' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactsGetUserEmailsResponse' + post: + tags: + - Contacts + summary: Create a new email + operationId: Contacts_addNewEmail + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmailPost' + required: true + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmail' + /users/{user-id}/contacts/emails/{id}: + get: + tags: + - Contacts + summary: Get a specific email + operationId: Contacts_getEmail + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmail' + put: + tags: + - Contacts + summary: Update a user's email + operationId: Contacts_updateUserEmail + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmailPost' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmail' + delete: + tags: + - Contacts + summary: Delete the user's specified email + operationId: Contacts_deleteUserEmail + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '204': + description: if deletion was successful + /users/{user-id}/contacts/phone-numbers: + get: + tags: + - Contacts + summary: Get a user's phone numbers + operationId: Contacts_getUserPhoneNumbers + parameters: + - $ref: '#/components/parameters/user-id-in-path' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactsGetUserPhoneNumbersResponse' + post: + tags: + - Contacts + summary: Create a phone number + operationId: Contacts_createPhoneNumber + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumberPost' + required: true + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumber' + /users/{user-id}/contacts/phone-numbers/{id}: + get: + tags: + - Contacts + summary: Get specific phone number + operationId: Contacts_getPhoneNumber + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumber' + put: + tags: + - Contacts + summary: Update a user's phone number + operationId: Contacts_updateUserPhoneNumber + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumberPost' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumber' + delete: + tags: + - Contacts + summary: Delete the user's specified phone number + operationId: Contacts_deletePhoneNumber + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/alerts: + get: + tags: + - Notification Preferences + summary: Get alert notification preferences of a user + operationId: NotificationPreferences_getUserAlerts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: >- + #/components/schemas/NotificationPreferencesGetUserAlertsResponse + post: + tags: + - Notification Preferences + summary: Create an alert notification preference + operationId: NotificationPreferences_createAlertPreference + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlertPost' + required: true + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlert' + /users/{user-id}/notification-preferences/alerts/{id}: + get: + tags: + - Notification Preferences + summary: Get specific notification preferences alert + operationId: NotificationPreferences_getSpecificAlert + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlert' + put: + tags: + - Notification Preferences + summary: Update a user's alert notification preference + operationId: NotificationPreferences_updateAlertPreference + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlertPost' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlert' + delete: + tags: + - Notification Preferences + summary: Delete the user's specified notification preferences alert + operationId: NotificationPreferences_deleteUserNotificationPreferencesAlert + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/duties: + get: + tags: + - Notification Preferences + summary: Get duty notification preferences of a user + operationId: NotificationPreferences_getUserDutyPreferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: >- + #/components/schemas/NotificationPreferencesGetUserDutyPreferencesResponse + post: + tags: + - Notification Preferences + summary: Create a duty notification preference + operationId: NotificationPreferences_createDuty + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDutyPost' + required: true + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDuty' + /users/{user-id}/notification-preferences/duties/{id}: + get: + tags: + - Notification Preferences + summary: Get specific notification preferences duty + operationId: NotificationPreferences_getSpecificDuty + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDuty' + put: + tags: + - Notification Preferences + summary: Update a user's duty notification preference + operationId: NotificationPreferences_updateDutyNotificationPreference + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDutyPost' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDuty' + delete: + tags: + - Notification Preferences + summary: Delete the user's specified notification preferences duty + operationId: NotificationPreferences_deleteUserNotificationDuty + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/updates: + get: + tags: + - Notification Preferences + summary: Get update notification preferences of a user + operationId: NotificationPreferences_getUserUpdatePreferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: >- + #/components/schemas/NotificationPreferencesGetUserUpdatePreferencesResponse + post: + tags: + - Notification Preferences + summary: Create an update notification preference + operationId: NotificationPreferences_createUpdatePreference + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdatePost' + required: true + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + /users/{user-id}/notification-preferences/updates/{id}: + get: + tags: + - Notification Preferences + summary: Get specific notification preferences update + operationId: NotificationPreferences_getSpecificUpdate + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + put: + tags: + - Notification Preferences + summary: Update a user's update notification preference + operationId: NotificationPreferences_updateUserUpdateNotificationPreference + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdatePost' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + delete: + tags: + - Notification Preferences + summary: Delete the user's specified notification preferences update + operationId: NotificationPreferences_deleteUpdate + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/subscriptions: + get: + tags: + - Notification Preferences + summary: Get subscription notification preferences of a user + operationId: NotificationPreferences_getUserSubscriptions + parameters: + - $ref: '#/components/parameters/user-id-in-path' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: >- + #/components/schemas/NotificationPreferencesGetUserSubscriptionsResponse + post: + tags: + - Notification Preferences + summary: Create a subscription notification preference + operationId: NotificationPreferences_createSubscriptionNotificationPreference + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscriptionPost' + required: true + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + /users/{user-id}/notification-preferences/subscriptions/{id}: + get: + tags: + - Notification Preferences + summary: Get specific notification preferences subscription + operationId: NotificationPreferences_getSpecificSubscription + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + put: + tags: + - Notification Preferences + summary: Update a user's subscription notification preference + operationId: NotificationPreferences_updateSubscriptionPreference + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscriptionPost' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + delete: + tags: + - Notification Preferences + summary: Delete the user's specified notification preferences subscription + operationId: NotificationPreferences_deleteSubscription + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + responses: + '204': + description: if deletion was successful + /numbers: + get: + tags: + - Numbers + summary: >- + List available phone numbers that ilert uses to send voice and SMS + notifications + operationId: Numbers_listAvailableNumbers + security: [] + responses: + '200': + description: List of phone numbers + content: + application/json: + schema: + $ref: '#/components/schemas/NumbersListAvailableNumbersResponse' + /integrations: + get: + tags: + - Integrations + summary: >- + List available inbound and outbound integrations. Note: this resource is + paginated. + operationId: Integrations_listAvailable + security: [] + parameters: + - $ref: '#/components/parameters/start-index' + - $ref: '#/components/parameters/max-results' + responses: + '200': + description: list of integrations + content: + application/json: + schema: + $ref: '#/components/schemas/IntegrationsListAvailableResponse' + /users: + get: + tags: + - Users + summary: List existing users. + operationId: Users_listExistingUsers + parameters: + - $ref: '#/components/parameters/start-index' + - $ref: '#/components/parameters/max-results' + responses: + '200': + description: list of users + content: + application/json: + schema: + $ref: '#/components/schemas/UsersListExistingUsersResponse' + post: + tags: + - Users + summary: Create a new user. Requires ADMIN privileges. + operationId: Users_createNewUser + description: | + **Sample request** + + ```json + Request URL: https://api.ilert.com/api/users + + { + "firstName": "John", + "lastName": "Doe", + "email": "john@acme.com", + "position": "Software Engineer", + } + ``` + + **Response** + + ````json + { + "id": 2188373, + "firstName": "John", + "lastName": "Doe", + "email": "john@acme.com", + "position": "Software Engineer", + "timezone": "Europe/Berlin", + "language": "de", + "role": "RESPONDER", + } + ```` + requestBody: + description: the user object + content: + application/json: + schema: + $ref: '#/components/schemas/UserPost' + responses: + '201': + description: >- + Created. The URI of the created user entity is included in the + Location header and the user object is included in the body. + content: + application/json: + schema: + $ref: '#/components/schemas/User' + /users/current: + get: + tags: + - Users + summary: Get the currently authenticated user. + operationId: Users_getCurrentUser + responses: + '200': + description: user object + content: + application/json: + schema: + $ref: '#/components/schemas/User' + put: + tags: + - Users + summary: Update the current user. + operationId: Users_updateCurrentUser + requestBody: + description: user object + content: + application/json: + schema: + $ref: '#/components/schemas/UserPost' + responses: + '200': + description: the updated user + content: + application/json: + schema: + $ref: '#/components/schemas/User' + /alerts: + post: + tags: + - Alerts + summary: >- + Create alerts with customised parameters without requiring events from + monitoring tools that use our Events API. + operationId: Alerts_createCustomizedAlert + description: >- + Escalation of the alert will be based on the alert source's escalation + policy or may be overridden by providing a specific escalation policy or + lastly specific set of responders (users), latter will only notify the + user(s) and will not escalate any further. + requestBody: + description: the alert + content: + application/json: + schema: + $ref: '#/components/schemas/ManualAlert' + required: true + responses: + '201': + description: the created and freshly escalated alert + content: + application/json: + schema: + $ref: '#/components/schemas/Alert' + get: + tags: + - Alerts + summary: >- + List alerts (optionally matching certain criteria that are specified by + query parameters). + operationId: Alerts_listMatchingCriteria + description: >- + **Sample URLs** + + * List only alerts that are either in state `PENDING` or `ACCEPTED`:This is an email to + be sent
+ text: + description: >- + The text body of the email. If none is provided this will be + generated from the HTML. Max size of 2 MB. + + If max size is exceeded, the entire api call will fail. + type: string + example: This is the text version of the email + EmailEventListModel: + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/EmailEvent' + EmailEvent: + type: object + properties: + messageId: + description: The id of the message. + type: string + example: id1 + eventType: + description: Contains a code for what event type the event is. + example: 3 + oneOf: + - $ref: '#/components/schemas/EmailEventType' + eventTypeDescription: + description: A text description of the event type + type: string + example: Delivered + eventTimestamp: + description: When the event happened e.g. 2001-02-30T14:50:23Z (UTC time) + type: string + example: '2001-02-30T14:50:23Z' + EmailEventType: + description: |- + 0 = Undefined + 1 = Clicked + 2 = Complained + 3 = Delivered + 4 = Opened + 5 = PermanentFail + 6 = TemporaryFail + 7 = Unsubscribed + 8 = Queued + 9 = Attempt + type: integer + x-enumNames: + - Undefined + - Clicked + - Complained + - Delivered + - Opened + - PermanentFail + - TemporaryFail + - Unsubscribed + - Queued + - Attempt + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + ApiPageModelOfEmailTemplateOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfEmailTemplateOutputApiModel' + - type: object + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfEmailTemplateOutputApiModel: + type: object + properties: + entries: + type: array + items: + $ref: '#/components/schemas/EmailTemplateOutputApiModel' + EmailTemplateOutputApiModel: + type: object + properties: + id: + description: The id of the email template + type: string + example: c9b6c7a8-aa22-4a59-b6d5-fdbbeced27bc + name: + description: The name of the email template + type: string + example: My email template + html: + description: The Html of the email template + type: string + example: >- +Hello {name} {lastname}. + This is an email to be sent
+ text: + description: The text version of the Html + type: string + example: Hello {name} This is the text version of the email + subject: + description: The subject of the email template + type: string + example: Hello {lastname} This is the subject of the email + preheader: + description: The preheader of the email + type: string + example: This is the preheader of the email + placeholders: + description: >- + A list of the placeholders found in the template html, text and + subject. + type: array + example: + - '{name}' + - '{lastname}' + items: + type: string + created: + description: >- + When the email template was created e.g. 2001-02-30T14:50:23Z (UTC + time) + type: string + example: '2001-02-30T14:50:23Z' + lastUpdated: + description: >- + When the email template was last updated e.g. 2001-02-30T14:50:23Z + (UTC time) + type: string + example: '2001-02-30T14:50:23Z' + RequestDeletionOutputApiModel: + type: object + properties: + id: + description: The Id of the Deletion request + type: string + example: cf97f715-63d4-41df-92a1-34eb87b866b5 + DeletionRequestCreateInfo: + type: object + properties: + numberInfo: + $ref: '#/components/schemas/NumberInfo' + ApiPageModelOfGroupOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfGroupOutputApiModel' + - type: object + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfGroupOutputApiModel: + type: object + properties: + entries: + type: array + items: + $ref: '#/components/schemas/GroupOutputApiModel' + GroupOutputApiModel: + type: object + properties: + id: + description: The id of the list + type: string + format: guid + example: a80e5daa-1bf9-48ca-b67e-ff79eeab1c39 + name: + description: The name of the list + type: string + example: My list + created: + description: When the list was created e.g. 2001-02-30T14:50:23Z (UTC time) + type: string + example: '2001-02-30T14:50:23Z' + GroupInputApiModel: + type: object + properties: + name: + type: string + ApiPageModelOfRecipientOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfRecipientOutputApiModel' + - type: object + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfRecipientOutputApiModel: + type: object + properties: + entries: + type: array + items: + $ref: '#/components/schemas/RecipientOutputApiModel' + RecipientOutputApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + properties: + id: + description: The id of the recipient + type: string + format: guid + example: 99e0543f-b059-4127-9b50-c42112f19cc9 + listId: + description: The id of the list that the recipient belongs to + type: string + format: guid + example: 4a5f91d5-3aa4-4419-890e-f7b103406dbf + created: + description: >- + When the recipient was created e.g. 2001-02-30T14:50:23Z (UTC + time) + type: string + example: '2001-02-30T14:50:23Z' + RecipientBaseApiModel: + type: object + x-abstract: true + properties: + externalCreated: + description: >- + When the recipient was created in an external system e.g. + 2001-02-30T14:50:23Z (UTC time) + type: string + example: '2001-02-30T14:50:23Z' + numberInfo: + $ref: '#/components/schemas/NumberInfo' + fields: + description: The fields to update in the given recipient. + example: + firstname: Friedhelm + lastname: Hillebrand + birthday: '1945-04-30' + custom1: Custom1 + custom2: Custom2 + custom3: Custom3 + custom4: Custom4 + custom5: Custom5 + custom6: Custom6 + email: test@test.dk + zipCode: '8000' + address: testroad 12 + companyName: test company + oneOf: + - $ref: '#/components/schemas/RecipientFieldsCollection' + RecipientFieldsCollection: + type: object + additionalProperties: + type: string + RecipientCreateOrUpdateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + RecipientUpdateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + RecipientCreateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + IncomingMessageListModel: + type: object + properties: + messages: + type: array + items: + $ref: '#/components/schemas/IncomingMessage' + IncomingMessage: + type: object + properties: + from: + $ref: '#/components/schemas/IncomingMessageSender' + to: + $ref: '#/components/schemas/IncomingMessageTarget' + text: + type: string + receivedAt: + type: string + example: '2001-02-30T14:50:23Z' + IncomingMessageSender: + type: object + properties: + countryCode: + type: string + phoneNumber: + type: string + rawSource: + type: string + isValidMsisdn: + type: boolean + IncomingMessageTarget: + type: object + properties: + countryCode: + type: string + phoneNumber: + type: string + msisdn: + type: string + SmsOutgoingPostReply: + type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateResultModel' + SmsOutgoingApiCreateResultModel: + type: object + properties: + numberDetails: + description: >- + The parsed details about the msisdn provided in the to-field of the + request (msisdn is a number with a countrycode e.g. 4512345678) + oneOf: + - $ref: '#/components/schemas/NumberDetails' + text: + description: The text message + type: string + example: This is a message text to be sent + from: + description: The sender. + type: string + example: PetShop + smsCount: + description: >- + The number of sms messages this message will be split into when sent + to the operator. Charging will also be done according to this + number. + type: integer + format: int32 + example: 1 + messageId: + description: >- + An optional message id used to identify the message. + + If no message id is provided, a new message id is generated and + assigned to the message. This id must be unique across all messages + created on the same account. + + (In case a previous message has been deleted according to GDPR + deletion rules setup on the specific account, the messageId is + allowed to be reused) + type: string + example: PetShop + encoding: + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2". In case + the message was submitted with encoding "auto", this report will + reveal the final encoding based on the characters in the message + text. + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + type: string + example: gsm7 + NumberDetails: + type: object + properties: + countryCode: + description: The country code part of the msisdn, e.g. 45. + type: string + example: '45' + phoneNumber: + description: The phone number part of the msisdn, e.g. 12345678. + type: string + example: '12345678' + rawMsisdn: + description: >- + The input msisdn in its unaltered format. This is the value provided + when sending the text message. + type: string + example: 45 12 34 56 78 + msisdn: + description: The final cleaned msisdn + type: string + example: '4512345678' + isValidMsisdn: + description: True if the input msisdn was valid. + type: boolean + example: true + countryHint: + description: The country code hint if provided in the request + type: string + SmsOutgoingPostRequest: + type: object + required: + - messages + properties: + messages: + description: >- + A list of the sms messages to be sent. Allowed to contain between 1 + and 250 elements. + type: array + maxItems: 250 + minItems: 1 + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateModel' + SmsOutgoingApiCreateModel: + allOf: + - $ref: '#/components/schemas/SmsOutgoingBaseApiModel' + - type: object + required: + - text + - from + properties: + text: + description: >- + The text message. + + If the max length is exceeded, the message text is truncated and + sent. + type: string + maxLength: 10000 + minLength: 1 + example: This is a message text to be sent + from: + description: >- + The sender. This can either be a 3-11 chars text sender or an up + to 14 digit long sender number. + + If the max length is exceeded, the string is truncated. + type: string + minLength: 1 + example: PetShop + flash: + description: >- + If true, the message will be shown as a flash message (also + known as a class0 message) on the target phone. If false, it + will be received as a standard text message. + + Default: false + type: boolean + nullable: true + example: false + encoding: + description: >- + The encoding of the message. Can be either "gsm7", "ucs2" or + "auto". + + "gsm7" is the default alfabet for text messages and when using + gsm7, a single sms message can contain 160 characters. If the + length exceeeds 160 characters, the message is actually split up + into parts of 153 characters and charged according to this. + Please note, that a few, specific characters fill up 2 bytes and + count for 2 letters. Ref: + https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along + with smileys. When using this encoding, a single message can + consist of 70 characters. If the message exceeds 70 characters, + the final message is actually split into parts of 67 characters. + + "auto" can be used in case the sender wishes to support + non-roman characters but wants to save the expenses on all the + trafic that only contains gsm characters anyway. + + Default: "gsm7" + type: string + example: gsm7 + SmsOutgoingBaseApiModel: + type: object + required: + - to + properties: + to: + description: >- + The msisdn (country code and number) to send to. (Remember to + include countrycode in all numbers, e.g. 4512345678). + + If max length is exceeded, the entire api call will fail. + type: string + maxLength: 20 + minLength: 0 + example: '4512345678' + countryHint: + description: >- + For optimal phone number validation, we encourage you to provide us + with a country code. This can be the numeric country code (like 44) + or the two-letter suffix (like GB). If this field is empty it is + important that you add the country code (e.g 44) in front of the + phone number in “to”. + type: string + maxLength: 50 + minLength: 0 + example: '45' + messageId: + description: >- + An optional message id used to identify the message. + + If no message id is provided, a new message id is generated and + assigned to the message. This id must be unique across all messages + created on the same account. + + (In case a previous message has been deleted according to GDPR + deletion rules setup on the specific account, the messageId is + allowed to be reused) + + If max length is exceeded, the entire api call will fail. + type: string + maxLength: 50 + minLength: 1 + example: PetShop + respectBlacklist: + description: >- + If true, this message will be blocked from sending if the target + number is on the account's blacklist. If false, the message will be + sent no matter blacklist settings. + + Default: true + type: boolean + nullable: true + example: true + validityPeriodInSeconds: + description: >- + The validity period in seconds. Minimum is 60 seconds and maximum is + 172800 (48 hours). + + If not specified, the messages is attempted to be delivered in 48 + hours. A typical use of validityPeriod is for messages that makes no + sense to delivery efter er certain time frame, in the case the phone + is turned of, e.g. two factor codes. + + Please note, that messages are still charged even though the + operator is cancelling the delivery attempt due to an exceeded + validity period. + type: integer + format: int32 + maximum: 172800 + minimum: 60 + nullable: true + example: 90 + statusCallbackUrl: + description: >- + In case you would like a callback from us when the message is + delivered, you can specify it here and we will call it when we have + new message statuses. + + The callback payload will be an array of status objects. + + Api calls sending messages with the same apikey will be subject to + being bulked together. + type: string + maxLength: 500 + minLength: 0 + example: https://[your_domain]/your/desired/path + sendTime: + description: >- + If set, this defines to time in the future for the message to be + sent. e.g. 2001-02-30T14:50:23Z (UTC time). + type: string + example: '2001-02-30T14:50:23Z' + msisdnCooldownInMinutes: + description: >- + If set, the message will be cancelled if the same mobile number + already have received a SMS within this specified time period. + + Fx. used to prevent spamming a mobile number. + + Minimum 60 minutes (1 hour) and maximum is 43200 minutes (30 days). + type: integer + format: int32 + maximum: 43200 + minimum: 60 + nullable: true + example: 1440 + StatusReportListModel: + type: object + properties: + reports: + type: array + items: + $ref: '#/components/schemas/StatusReport' + StatusReport: + type: object + properties: + messageId: + description: The id of the message. + type: string + example: id1 + numberDetails: + $ref: '#/components/schemas/StatusReportNumberDetails' + deliveryInfo: + $ref: '#/components/schemas/DeliveryInfo' + chargeInfo: + $ref: '#/components/schemas/ChargeInfo' + StatusReportNumberDetails: + allOf: + - $ref: '#/components/schemas/NumberDetails' + - type: object + properties: + isAnonymized: + description: Specifies whether the message has been anonymized or not. + type: boolean + example: false + DeliveryInfo: + type: object + properties: + stateCode: + description: >- + Contains a code indicating whether a message is delivered, failed or + cancelled. + example: -1 + oneOf: + - $ref: '#/components/schemas/MessageStateCode' + stateDescription: + description: A text description of the state code + type: string + example: Failed + sendTime: + description: When the message was sent e.g. 2001-02-30T14:50:23Z (UTC time) + type: string + example: '2001-02-30T14:50:23Z' + doneTime: + description: >- + When the delivery of the message fails, is cancelled, or is + delivered. If the operator does not support reporting the actual + delivery time, this will be the time when the delivery report is + received from the operator. + + In some cases where the message is not sent, this value can be null. + type: string + example: '2001-02-30T14:50:23Z' + errorCode: + $ref: '#/components/schemas/ErrorCode' + errorDescription: + description: A text description of the error code + type: string + example: Undeliverable message + MessageStateCode: + description: |- + 0 = Unknown + 1 = Delivered + -2 = Cancelled + -1 = Failed + type: integer + x-enumNames: + - Unknown + - Delivered + - Cancelled + - Failed + enum: + - 0 + - 1 + - -2 + - -1 + ErrorCode: + description: "A code describing the error if the state is not Delivered. This property will be absent in case the state is Delivered.\n\r-1 = Undeliverable message\n\r-2 = Msisdn blacklisted by operator\n\r-3 = Invalid mobile number\n\r-4 = Country not available\n\r-5 = Delivery timeout\n\r-6 = Not delivered removed from gateway\n\r-8 = Insufficient funds\n\r-9 = Authorize failed\n\r-10 = Capture failed\n\r-11 = Overcharge donation limit exceeded\n\r-12 = Overcharge type not activated\n\r-13 = Overcharge settings not valid\n\r-14 = Sender name blocked\n\r-15 = Route not available\n\r-16 = Refund not available\n\r-17 = Refund not possible for message\n\r-18 = Refund failed\n\r-19 = Refund not possible for pending message\n\r-20 = Refund not possible for failed message\n\r-21 = Refund failed already refunded\n\r-22 = Delivery timeout before sent\n\r-23 = Message queue full at operator\n\r-80 = Imported from other system\n\r-99 = Submit failed\n\r-100 = Communication error\n\r-101 = Unknown id\n\r-102 = Cancelled\n\r-103 = Unknown error processing message\n\r-104 = Unknown id at operator\n\r-105 = Msisdn blacklisted on account\n\r-106 = Mobile number cooldown\n\r-201 = Suspicious sms content\n\r-202 = Account deactivated\n\r-300 = Pdu sequence incomplete\n\r-301 = Pdu sequence invalid\n\r" + type: integer + format: integer + example: -1 + ChargeInfo: + type: object + properties: + isCharged: + description: True if the message will be charged. + type: boolean + example: true + smsCount: + description: >- + The total sms count in the message. If IsCharged is true, this is + the number of sms'es that will be charged. + type: integer + format: int32 + example: 2 + encoding: + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2". In case + the message was submitted with encoding "auto", this report will + reveal the final encoding based on the characters in the message + text. + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + type: string + example: gsm7 + SmsOutgoingTemplatePostReply: + type: object + properties: + usedPlaceholderKeys: + description: A list of used used placeholder keys + type: array + example: + - '{name}' + - '{lastname}' + items: + type: string + notUsedPlaceholderKeys: + description: A list of not used placeholder keys + type: array + example: + - '{name}' + - '{lastname}' + items: + type: string + results: + type: array + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateResultModel' + SmsOutgoingTemplatePostRequest: + type: object + required: + - templateId + - messages + properties: + templateId: + description: The id of the template to use + type: string + minLength: 1 + example: ecdcb257-c1e9-4b44-8a4e-f05822372d82 + messages: + description: >- + A list of the sms messages to be sent. Allowed to contain between 1 + and 250 elements. + type: array + maxItems: 250 + minItems: 1 + items: + $ref: '#/components/schemas/SmsOutgoingTemplateApiCreateModel' + SmsOutgoingTemplateApiCreateModel: + allOf: + - $ref: '#/components/schemas/SmsOutgoingBaseApiModel' + - type: object + properties: + placeholders: + description: >- + A key-value list of placeholders to replace in the template + text. Keys must be encapsulated with {}. E.g. {NAME}. + example: + '{name}': Friedhelm + '{lastname}': Hillebrand + oneOf: + - $ref: '#/components/schemas/ApiPlaceholderValueCollection' + SmsOutgoingCancelPostReply: + type: object + properties: + results: + description: A list of results + type: array + items: + $ref: '#/components/schemas/SmsOutgoingCancelPostReplyResultModel' + SmsOutgoingCancelPostReplyResultModel: + type: object + properties: + messageId: + description: The MessageId of the message that was attempted cancelled. + type: string + example: 8fe266b2-56e9-4b5f-938f-cc5e22530721 + resultCode: + description: A value indicating if the message was cancelled. + example: 1 + oneOf: + - $ref: '#/components/schemas/CancelResultCode' + resultDescription: + description: A description of the result. + type: string + example: Success + CancelResultCode: + description: |- + 0 = Unknown + 1 = Success + -2 = MessageNotFound + -1 = NotCancelled + type: integer + x-enumNames: + - Unknown + - Success + - MessageNotFound + - NotCancelled + enum: + - 0 + - 1 + - -2 + - -1 + SmsOutgoingCancelPostRequest: + type: object + required: + - messageIds + properties: + messageIds: + description: >- + A list of the sms message ids to be cancelled. Allowed to contain + between 1 and 250 elements. + type: array + maxItems: 250 + minItems: 1 + example: + - id1 + - id2 + items: + type: string + ApiPageModelOfStandardTextOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfStandardTextOutputApiModel' + - type: object + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfStandardTextOutputApiModel: + type: object + properties: + entries: + type: array + items: + $ref: '#/components/schemas/StandardTextOutputApiModel' + StandardTextOutputApiModel: + type: object + properties: + id: + description: The id of the template + type: string + example: c7114ec3-8f89-4e26-8048-686585c1da2a + name: + description: The name of the template + type: string + example: My template + text: + description: The template text + type: string + example: My template text {name} {lastname} + senderName: + description: The sendername to use with this template + type: string + example: My sendername + encoding: + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2" + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + type: string + example: gsm7 + placeholders: + description: >- + A list of the placeholders found in the template html, text and + subject. + type: array + example: + - '{name}' + - '{lastname}' + items: + type: string + created: + description: When the template was created e.g. 2001-02-30T14:50:23Z (UTC time) + type: string + example: '2001-02-30T14:50:23Z' + lastUpdated: + description: >- + When the template was last updated e.g. 2001-02-30T14:50:23Z (UTC + time) + type: string + example: '2001-02-30T14:50:23Z' + ParsePhoneNumberPostReply: + type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/NumberDetails' + ParsePhoneNumberPostRequest: + type: object + required: + - numbersToParse + properties: + numbersToParse: + description: A list of the numbersToParse and country hints to be parsed + type: array + minItems: 1 + items: + $ref: '#/components/schemas/RawMsisdnAndCountryHint' + RawMsisdnAndCountryHint: + type: object + properties: + countryHint: + description: The country part of the msisdn, e.g. 45 or DK. + type: string + example: '45' + rawMsisdn: + description: >- + The input msisdn in its unaltered format. This is the value provided + when sending the text message. + type: string + example: +45 12 34 56 78 + securitySchemes: + BasicAuth: + description: >- + Provide Basic Authentiation with an arbitrary username and your api key + as password, e.g. some_value_to_be_ignored:your_api_key_here + type: http + scheme: basic + QueryParameter: + description: >- + Specify your apikey in the url as + https://api.inmobile.com/some/path?apikey=your_api_key_here. This method + is only recommended if basic authorization is not possible. + type: apiKey + name: apikey + in: query +security: + - BasicAuth: [] + - QueryParameter: [] +x-generator: NSwag v13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0)) diff --git a/sdks/db/fixed-specs/innoship-fixed-spec.yaml b/sdks/db/fixed-specs/innoship-fixed-spec.yaml new file mode 100644 index 0000000000..3411d043ee --- /dev/null +++ b/sdks/db/fixed-specs/innoship-fixed-spec.yaml @@ -0,0 +1,8496 @@ +openapi: 3.0.1 +info: + title: Innoship API + description: Api service implementation (version:6.0.1.503) + version: v1 + termsOfService: https://example.com/terms + contact: + name: Andrei Paul + email: andrei@innoship.ro + license: + name: Use under LICX + url: https://example.com/license +servers: + - url: https://api.innoship.com +tags: + - name: Order + - name: ClientLocation + - name: Location + - name: Label + - name: OfflineOrder + - name: Courier + - name: Manifest + - name: Track + - name: Voucher + - name: Feedback + - name: Notifications + - name: Price +paths: + /api/ClientLocation: + get: + tags: + - ClientLocation + operationId: ClientLocation_getDetail + parameters: + - name: countryCode + in: query + schema: + type: string + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + post: + tags: + - ClientLocation + operationId: ClientLocation_createNew + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + text/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + responses: + '200': + description: Success + /api/ClientLocation/{id}: + put: + tags: + - ClientLocation + operationId: ClientLocation_updateById + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + text/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + responses: + '200': + description: Success + delete: + tags: + - ClientLocation + operationId: ClientLocation_removeById + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + get: + tags: + - ClientLocation + operationId: ClientLocation_getById + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/ClientLocation/Summary: + post: + tags: + - ClientLocation + operationId: ClientLocation_createSummaryReport + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocationFilter' + text/json: + schema: + $ref: '#/components/schemas/LocationFilter' + application/json-patch+json: + schema: + $ref: '#/components/schemas/LocationFilter' + application/*+json: + schema: + $ref: '#/components/schemas/LocationFilter' + responses: + '200': + description: Success + /api/ClientLocation/Validate: + post: + tags: + - ClientLocation + operationId: ClientLocation_validateLocationDetails + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocationDto' + text/json: + schema: + $ref: '#/components/schemas/LocationDto' + application/json-patch+json: + schema: + $ref: '#/components/schemas/LocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/LocationDto' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/Courier: + post: + tags: + - ClientLocation + operationId: ClientLocation_createCourier + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + text/json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + application/json-patch+json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + application/*+json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/Courier/{courierId}: + delete: + tags: + - ClientLocation + operationId: ClientLocation_removeCourierById + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - name: force + in: query + schema: + type: boolean + - name: isEmagMarketPlace + in: query + schema: + type: boolean + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/CourierServices: + put: + tags: + - ClientLocation + operationId: ClientLocation_updateCourierServices + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: applyToAllLocations + in: query + schema: + type: boolean + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientLocationUpdateCourierServicesRequest5' + text/json: + schema: + $ref: '#/components/schemas/ClientLocationUpdateCourierServicesRequest6' + application/json-patch+json: + schema: + $ref: '#/components/schemas/ClientLocationUpdateCourierServicesRequest4' + application/*+json: + schema: + $ref: '#/components/schemas/ClientLocationUpdateCourierServicesRequest7' + responses: + '200': + description: Success + patch: + tags: + - ClientLocation + operationId: ClientLocation_updateCourierServices + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: applyToAllLocations + in: query + schema: + type: boolean + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientLocationUpdateCourierServicesRequest1' + text/json: + schema: + $ref: '#/components/schemas/ClientLocationUpdateCourierServicesRequest2' + application/json-patch+json: + schema: + $ref: '#/components/schemas/ClientLocationUpdateCourierServicesRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ClientLocationUpdateCourierServicesRequest3' + responses: + '200': + description: Success + /api/Courier/RequestPickup: + post: + tags: + - Courier + summary: Request pickup to courier + operationId: Courier_requestPickup + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/PickupRequest' + text/json: + schema: + $ref: '#/components/schemas/PickupRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/PickupRequest' + application/*+json: + schema: + $ref: '#/components/schemas/PickupRequest' + responses: + '200': + description: Pickup requested to courier + content: + application/json: + schema: + $ref: '#/components/schemas/PickupResponse' + '400': + description: Unable to request pickup due to errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Courier/All: + get: + tags: + - Courier + summary: Get all couriers + operationId: Courier_getAll + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: List of couriers + content: + application/json: + schema: + $ref: '#/components/schemas/CourierGetAllResponse' + '401': + description: Unable to authorize request + /api/Feedback/{from}/{to}: + get: + tags: + - Feedback + operationId: Feedback_getBetweenDates + parameters: + - name: from + in: path + required: true + schema: + type: string + format: date-time + - name: to + in: path + required: true + schema: + type: string + format: date-time + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/Label/by-courier/{courierId}/awb/{awb}: + get: + tags: + - Label + summary: Gets the label for the specified courier awb number + operationId: Label_getByCourierAwb + parameters: + - description: '' + name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - description: '' + name: awb + in: path + required: true + schema: + type: string + - description: '' + name: type + in: query + schema: + type: string + default: PDF + - description: '' + name: format + in: query + schema: + type: string + default: A6 + - description: '' + name: includeVoucher + in: query + schema: + type: boolean + default: false + - description: '' + name: useFile + in: query + schema: + type: boolean + default: true + - description: '' + name: skipCache + in: query + schema: + type: boolean + default: false + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/by-courier/{courierId}/voucher/{awb}: + get: + tags: + - Label + summary: Gets the voucher label for the specified courier awb number + operationId: Label_getVoucherByCourierAwb + parameters: + - description: '' + name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - description: '' + name: awb + in: path + required: true + schema: + type: string + - description: '' + name: type + in: query + schema: + type: string + default: PDF + - description: '' + name: format + in: query + schema: + type: string + default: A6 + - description: '' + name: useFile + in: query + schema: + type: boolean + default: true + - description: '' + name: skipCache + in: query + schema: + type: boolean + default: false + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/by-courier/{courierId}/awb/{awb}/parcel/{barcodes}: + get: + tags: + - Label + summary: Gets the label for the specified courier parcel barcode and order awb + operationId: Label_getByAwbAndParcel + parameters: + - description: '' + name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - description: '' + name: awb + in: path + required: true + schema: + type: string + - description: '' + name: barcodes + in: path + required: true + schema: + type: string + - description: '' + name: type + in: query + schema: + type: string + default: PDF + - description: '' + name: format + in: query + schema: + type: string + default: A6 + - description: '' + name: useFile + in: query + schema: + type: boolean + default: true + - description: '' + name: skipCache + in: query + schema: + type: boolean + default: false + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/bulk: + post: + tags: + - Label + summary: Create bulk labels operation + operationId: Label_createBulk + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + text/json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + responses: + '200': + description: Returns OperationId + '400': + description: Unable to create bulk labels operation due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/bulk/{operationId}: + get: + tags: + - Label + summary: Get bulk labels by operationId + operationId: Label_getBulkByOperationId + parameters: + - description: '' + name: operationId + in: path + required: true + schema: + type: string + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Location/ClientLocations: + get: + tags: + - Location + operationId: Location_getClientLocations + responses: + '200': + description: Success + /api/Location/FixedLocation/{id}: + get: + tags: + - Location + operationId: Location_getFixedLocationById + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: Success + /api/Location/FixedLocations: + get: + tags: + - Location + operationId: Location_getFixedLocations + parameters: + - name: Courier + in: query + schema: + $ref: '#/components/schemas/Courier' + - name: CountryCode + in: query + schema: + type: string + - name: CountyName + in: query + schema: + type: string + - name: LocalityName + in: query + schema: + type: string + - name: FixedLocationType + in: query + schema: + $ref: '#/components/schemas/FixedLocationType' + - name: ShowInactive + in: query + schema: + type: boolean + - name: RestrictionParcelsCount + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeHeight + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeWidth + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeLength + in: query + schema: + type: integer + format: int32 + - name: ExternalLocationId + in: query + schema: + type: string + - name: Latitude + in: query + schema: + type: number + format: double + - name: Longitude + in: query + schema: + type: number + format: double + - name: Radius + in: query + schema: + type: number + format: double + responses: + '200': + description: Success + /api/Location/Countries: + get: + tags: + - Location + operationId: Location_getCountryList + responses: + '200': + description: Success + /api/Location/Counties/{countryCode}: + get: + tags: + - Location + operationId: Location_getCountiesByCountryCode + parameters: + - name: countryCode + in: path + required: true + schema: + type: string + responses: + '200': + description: Success + /api/Location/Localities/{countyId}: + get: + tags: + - Location + operationId: Location_getLocalitiesByCountyId + parameters: + - name: countyId + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: Success + /api/Location/Postalcodes/{CountryCode}/{PostalCode}: + get: + tags: + - Location + operationId: Location_getPostalCodeDetails + parameters: + - name: CountryCode + in: path + required: true + schema: + maxLength: 2 + minLength: 2 + pattern: ^[a-z]*$ + type: string + - name: PostalCode + in: path + required: true + schema: + type: string + - name: CourierId + in: query + schema: + type: integer + format: int32 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + text/json: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + text/plain: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + /api/Location/Postalcodes/{LocalityId}: + get: + tags: + - Location + operationId: Location_getPostalcodesByLocalityId + parameters: + - name: LocalityId + in: path + required: true + schema: + type: integer + format: int32 + - name: CourierId + in: query + schema: + type: integer + format: int32 + - name: filter + in: query + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/LocationGetPostalcodesByLocalityId200Response + text/json: + schema: + $ref: >- + #/components/schemas/LocationGetPostalcodesByLocalityId200Response + text/plain: + schema: + $ref: >- + #/components/schemas/LocationGetPostalcodesByLocalityIdResponse + /api/Location/Postalcodes/Country/{CountryCode}: + get: + tags: + - Location + operationId: Location_getPostalCodesByCountry + parameters: + - name: CountryCode + in: path + required: true + schema: + maxLength: 2 + minLength: 2 + pattern: ^[a-z]*$ + type: string + - name: CourierId + in: query + schema: + type: integer + format: int32 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + text/json: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + text/plain: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + /api/Manifest: + post: + tags: + - Manifest + summary: Requests pickup and get manifest id + operationId: Manifest_requestPickupAndManifestId + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ManifestRequest' + text/json: + schema: + $ref: '#/components/schemas/ManifestRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/ManifestRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ManifestRequest' + responses: + '200': + description: Returns ManifestId + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + get: + tags: + - Manifest + summary: Requests manifest report by id + operationId: Manifest_reportById + parameters: + - description: '' + name: manifestId + in: query + schema: + type: integer + format: int64 + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns PDF + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Notifications/sendsms: + post: + tags: + - Notifications + operationId: Notifications_sendSmsNotification + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + text/json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + responses: + '200': + description: Success + /api/OfflineOrder/Activate: + put: + tags: + - OfflineOrder + summary: Activate Offline Orders + operationId: OfflineOrder_activateOrder + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/OfflineOrderActivateOrderRequest1' + text/json: + schema: + $ref: '#/components/schemas/OfflineOrderActivateOrderRequest2' + application/json-patch+json: + schema: + $ref: '#/components/schemas/OfflineOrderActivateOrderRequest' + application/*+json: + schema: + $ref: '#/components/schemas/OfflineOrderActivateOrderRequest3' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/OfflineOrder/Edit: + put: + tags: + - OfflineOrder + summary: Edit Offline Orders + operationId: OfflineOrder_updateOrderDetails + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/OfflineOrderUpdateOrderDetailsRequest1' + text/json: + schema: + $ref: '#/components/schemas/OfflineOrderUpdateOrderDetailsRequest2' + application/json-patch+json: + schema: + $ref: '#/components/schemas/OfflineOrderUpdateOrderDetailsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/OfflineOrderUpdateOrderDetailsRequest3' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/OfflineOrder/Add: + post: + tags: + - OfflineOrder + summary: Add Offline Orders + operationId: OfflineOrder_addOrder + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/OfflineOrderAddOrderRequest1' + text/json: + schema: + $ref: '#/components/schemas/OfflineOrderAddOrderRequest2' + application/json-patch+json: + schema: + $ref: '#/components/schemas/OfflineOrderAddOrderRequest' + application/*+json: + schema: + $ref: '#/components/schemas/OfflineOrderAddOrderRequest3' + responses: + '200': + description: Added successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/Order: + post: + tags: + - Order + summary: Creates a new order + operationId: Order_createNewOrder + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Creates an new order in the system + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/simulate: + post: + tags: + - Order + operationId: Order_simulateOrder + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/validate: + post: + tags: + - Order + summary: Validates a new order request + operationId: Order_validateNewOrder + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '201': + description: Creates an new order in the system + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/multiple/simulate: + post: + tags: + - Order + operationId: Order_simulateMultiple + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderSimulateMultipleRequest1' + example: + - parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderSimulateMultipleRequest2' + example: + - parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderSimulateMultipleRequest' + example: + - parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderSimulateMultipleRequest3' + example: + - parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderSimulateMultipleResponse' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/OrderSimulateMultiple400Response' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/OrderSimulateMultiple401Response' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + /api/Order/file: + post: + tags: + - Order + operationId: Order_uploadFile + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderUploadFileResponse' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/{courierId}/awb/{awbNo}: + delete: + tags: + - Order + summary: Deletes an existing order + operationId: Order_deleteExistingOrder + parameters: + - description: Courier id + name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - description: AWB number + name: awbNo + in: path + required: true + schema: + type: string + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '201': + description: Deletes an existing order from the system + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to delete the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateStatus: + post: + tags: + - Order + summary: Updates orders statuses + operationId: Order_updateStatus + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/OrderUpdateStatusRequest1' + text/json: + schema: + $ref: '#/components/schemas/OrderUpdateStatusRequest2' + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderUpdateStatusRequest' + application/*+json: + schema: + $ref: '#/components/schemas/OrderUpdateStatusRequest3' + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateParcels: + post: + tags: + - Order + summary: Create a new order based on the existing one and cancel the original + operationId: Order_updateParcels + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + text/json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + responses: + '200': + description: Creates an new order in the system + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateCustomAttributes/{courierId}/awb/{awb}: + post: + tags: + - Order + summary: Updates custom attributes + operationId: Order_updateCustomAttributes + parameters: + - description: Courier id + name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - description: AWB number + name: awb + in: path + required: true + schema: + type: string + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/OrderUpdateCustomAttributesRequest1' + text/json: + schema: + $ref: '#/components/schemas/OrderUpdateCustomAttributesRequest2' + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderUpdateCustomAttributesRequest' + application/*+json: + schema: + $ref: '#/components/schemas/OrderUpdateCustomAttributesRequest3' + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/by-location/{externalLocationId}/{from}/{to}: + get: + tags: + - Order + summary: Retrieve orders by externalLocationId with dates filter + operationId: Order_getByLocationDates + parameters: + - description: External Location Id + name: externalLocationId + in: path + required: true + schema: + type: string + - description: From date + name: from + in: path + required: true + schema: + type: string + format: date-time + - description: To date + name: to + in: path + required: true + schema: + type: string + format: date-time + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/ReturnAwbInfo/{courierId}/{returnAwb}: + get: + tags: + - Order + operationId: Order_getReturnAwbInfo + parameters: + - name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - name: returnAwb + in: path + required: true + schema: + type: string + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + responses: + default: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UploadDocuments: + post: + tags: + - Order + summary: UploadDocuments + operationId: Order_uploadDocuments + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + text/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + responses: + '200': + description: Document uploaded + content: + application/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiResponse' + '400': + description: Unable to upload documents + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Price: + post: + tags: + - Price + summary: Gets the prices for the specified request + operationId: Price_getPrices + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - description: article description + quantity: 1 + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: List of prices for eligible couriers + content: + application/json: + schema: + $ref: '#/components/schemas/PriceResponse' + '400': + description: Unable to get prices due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Track/by-awb/with-return: + post: + tags: + - Track + summary: Track by Order Courier AWB with return info + operationId: Track_orderCourierAwbWithReturn + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackRequest' + text/json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TrackRequest' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TrackOrderCourierAwbWithReturn200Response' + text/json: + schema: + $ref: '#/components/schemas/TrackOrderCourierAwbWithReturn200Response' + text/plain: + schema: + $ref: '#/components/schemas/TrackOrderCourierAwbWithReturnResponse' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/plain: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Track/return/by-awb: + post: + tags: + - Track + summary: Track Retrun by Courier AWB + operationId: Track_byAwb + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackRequest' + text/json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TrackRequest' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TrackByAwb200Response' + text/json: + schema: + $ref: '#/components/schemas/TrackByAwb200Response' + text/plain: + schema: + $ref: '#/components/schemas/TrackByAwbResponse' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/plain: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Voucher/Create: + post: + tags: + - Voucher + summary: Create Voucher + operationId: Voucher_generateNewVoucher + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + text/json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/Voucher/Activate: + post: + tags: + - Voucher + summary: Activate Voucher + operationId: Voucher_activateVoucher + parameters: + - description: The requested API version + name: api-version + in: query + required: true + schema: + type: string + default: '1.0' + - description: The requested API version + name: api-version + in: header + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + text/json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + application/json-patch+json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request +components: + schemas: + ActivateAddress: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + country: + type: string + nullable: true + countryName: + type: string + nullable: true + countyId: + type: integer + format: int32 + nullable: true + localityId: + type: integer + format: int32 + nullable: true + countryId: + type: integer + format: int32 + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + postalCode: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + fixedLocationId: + type: string + nullable: true + fixedLocationName: + type: string + nullable: true + courierFixedLocationId: + type: string + nullable: true + ActivateOrderApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + shipmentDate: + type: string + format: date-time + nullable: true + shipmentDateEnd: + type: string + format: date-time + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/ActivateOrderParcel' + nullable: true + addressFrom: + $ref: '#/components/schemas/ActivateAddress' + addressTo: + $ref: '#/components/schemas/ActivateAddress' + ActivateOrderParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/ActivateOrderParcelSize' + weight: + type: number + format: double + ActivateOrderParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + ActivateVoucherApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + courierShipmentVoucher: + type: string + nullable: true + AllCouriersResponse: + type: object + properties: + courierId: + type: integer + format: int32 + courier: + type: string + nullable: true + courierDisplayName: + type: string + nullable: true + BulkLabelApiRequest: + type: object + properties: + labelType: + $ref: '#/components/schemas/LabelType' + labelFormat: + $ref: '#/components/schemas/LabelFormat' + useFile: + type: boolean + includeVoucher: + type: boolean + awBs: + type: array + items: + $ref: '#/components/schemas/BulkLabelApiRequestItem' + nullable: true + BulkLabelApiRequestItem: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + typeId: + type: integer + format: int32 + courierShipmentId: + type: string + nullable: true + ClientPreferences: + type: object + properties: + preferredLabel: + $ref: '#/components/schemas/LabelFormat' + preferredLocationId: + type: integer + format: int32 + nullable: true + orderColumns: + type: array + items: + type: string + nullable: true + pickupColumns: + type: array + items: + type: string + nullable: true + returnColumns: + type: array + items: + type: string + nullable: true + Courier: + enum: + - Cargus + - DPD + - FanCourier + - GLS + - Nemo + - Sameday + - ExpressOne + - ECont + - TeamCourier + - DHL + - PostaRomana + - PostaPanduri + - GLS_HU + - DragonStar + - Coletaria + - Bookurier + - Asendia + - TNT + - DPD_BG + - GLS_HR + - GLS_CZ + - GLS_SI + - GLS_SK + - InOut + - StackCurier + - GebruderWeiss + - Pallex + - GT + - CourierManager + - GLS_IT + - ECourier + - Unimasters + - TCE + - TransilvaniaPost + - BGPost + - Evropat + - SMPCourier + - DHL_DE + - Raben + - Memex + - PTTExpress + - XDCourier + - IL + - NovaPosta + - PinkPost + - Strongo + - DHL_Paket + - DHL_Parcel + - BeeFast + - InPost + - KLG + - Schenker + - Packageez + - Kargo + - SundayCourier + - PocztaPolska + - Sinapseria + - UPS + - DPD_HR + - DPD_SI + - NovaPoshtaGlobal + - ALD + - ProNatur + - DPD_HU + - GLS_PL + - Futar24h + - SlovakParcelService + - DPD_DE + - VanOnGo + - CeskaPosta + - DPD_SK + - SolAir + - PostaSlovenije + - DPD_PL + - Agil24 + - OrlenPackza + - Speedex + - FedEx + - DPD_UK + - PPL + - EColet + - ACS + - Helpship + - DPD_CZ + - MagyarPosta + - EVRI + - FedEx_PL + - KuehneNagel + - Sameday_BG + - Sameday_HU + - FanDelivery + - Seur + - Correos + - Couriera + - ChopChop + - InPost_ES + - FanCourierMoldova + - GLS_DE + - Kurier123 + - Dachser + - CTT_PT + - DPD_AT + - PostNord + - Pharmalink + - MRW + - Eurolog + - IDLogistics + - GLS_DK + - RoyalMail + - FanInternational + - Go4 + - InPost_IT + - AmazonShipping_IT + - TNT_IT + - Posta_SK + - Posta_AT + - GLS_ES + - LithuanianPost + - DHL_Parcel_DE + - DPD_LT + - ExpressOne_BG + - FoxPost + - Posta_NL + - InnoshipMocked + type: string + CourierServiceRestrictionsDto: + type: object + properties: + piecesCountMin: + type: integer + format: int32 + nullable: true + piecesCountMax: + type: integer + format: int32 + nullable: true + weightMin: + type: integer + format: int32 + nullable: true + weightMax: + type: integer + format: int32 + nullable: true + parcelWeightMin: + type: integer + format: int32 + nullable: true + parcelWeightMax: + type: integer + format: int32 + nullable: true + widthMin: + type: integer + format: int32 + nullable: true + widthMax: + type: integer + format: int32 + nullable: true + heightMin: + type: integer + format: int32 + nullable: true + heightMax: + type: integer + format: int32 + nullable: true + lengthMin: + type: integer + format: int32 + nullable: true + lengthMax: + type: integer + format: int32 + nullable: true + orderCountMax: + type: integer + format: int32 + nullable: true + orderPiecesCountMax: + type: integer + format: int32 + nullable: true + orderLocationCountMax: + type: array + items: + $ref: '#/components/schemas/RestrictionCountryCountyDto' + nullable: true + orderLocationPiecesCountMax: + type: array + items: + $ref: '#/components/schemas/RestrictionCountryCountyDto' + nullable: true + allowsCOD: + type: boolean + nullable: true + allowsBankCOD: + type: boolean + nullable: true + allowsNoSizeForParcels: + type: boolean + nullable: true + allowsPickUp: + type: boolean + nullable: true + allowsOrder: + type: boolean + nullable: true + allowsEmptyPostalCode: + type: boolean + nullable: true + allowsReturnDocument: + type: boolean + nullable: true + allowsReturnPackage: + type: boolean + nullable: true + allowsOversized: + type: boolean + nullable: true + allowsInsurance: + type: boolean + nullable: true + allowsSaturdayDelivery: + type: boolean + nullable: true + allowsOpenPackage: + type: boolean + nullable: true + courierCutOffTime: + type: string + format: date-span + nullable: true + CreateLocationCourierServicesDto: + type: object + properties: + courierId: + type: integer + format: int32 + isEmagMarketPlace: + type: boolean + CreateVoucherApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + voucherCourier: + $ref: '#/components/schemas/Courier' + insuranceAmount: + type: number + format: double + insuranceCurrency: + type: string + nullable: true + EditOrderApiRequest: + type: object + properties: + offlineStatusId: + $ref: '#/components/schemas/OrderOfflineStatus' + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + shipmentDate: + type: string + format: date-time + nullable: true + shipmentDateEnd: + type: string + format: date-time + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/ActivateOrderParcel' + nullable: true + addressFrom: + $ref: '#/components/schemas/ActivateAddress' + addressTo: + $ref: '#/components/schemas/ActivateAddress' + Error: + type: object + properties: + context: + type: string + nullable: true + message: + type: string + nullable: true + details: + type: array + items: + $ref: '#/components/schemas/Error' + nullable: true + ErrorResponse: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorResponseItem' + nullable: true + correlationId: + type: string + nullable: true + ErrorResponseItem: + type: object + properties: + message: + type: string + nullable: true + details: + type: array + items: + type: string + nullable: true + FixedLocationType: + enum: + - Locker + - PickupPoint + type: string + LabelFormat: + enum: + - A4 + - A6 + - T_85x85 + - A6_300dpi + - A4_4xA6 + - A6_10x9 + type: string + LabelResponse: + type: object + properties: + courier: + type: integer + format: int32 + contents: + type: string + nullable: true + labels: + type: array + items: + type: string + nullable: true + LabelType: + enum: + - Pdf + - Html + - Zpl + type: string + LimitedAddress: + type: object + properties: + country: + type: string + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + postalCode: + type: string + nullable: true + LocalityPostalCodeInfo: + type: object + properties: + localityId: + type: integer + format: int32 + postalCode: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNameLocalized: + type: string + nullable: true + neighbourhoodName: + type: string + nullable: true + neighbourhoodNameLocalized: + type: string + nullable: true + streetPrefix: + type: string + nullable: true + streetPrefixLocalized: + type: string + nullable: true + LocationAddressDto: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + postalCode: + type: string + nullable: true + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countryCode: + type: string + nullable: true + countryName: + type: string + nullable: true + ignoreLocalityId: + type: boolean + latitude: + type: number + format: double + nullable: true + longitude: + type: number + format: double + nullable: true + LocationCourierServiceDto: + type: object + properties: + courierId: + type: integer + format: int32 + courier: + type: string + nullable: true + courierDisplayName: + type: string + nullable: true + serviceId: + type: integer + format: int32 + service: + type: string + nullable: true + serviceGroupId: + type: integer + format: int32 + serviceGroupName: + type: string + nullable: true + hasValidationError: + type: boolean + nullable: true + courierServiceRestrictions: + $ref: '#/components/schemas/CourierServiceRestrictionsDto' + useCourierPrices: + type: boolean + nullable: true + mappingTemplateOptionId: + type: string + nullable: true + voucherTemplateOptionId: + type: string + nullable: true + extraServices: + type: object + additionalProperties: + type: boolean + nullable: true + nullable: true + mappingReferences: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + countryDeliveryDays: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + enabled: + type: boolean + nullable: true + localityKm: + type: integer + format: int32 + nullable: true + priceLocalityId: + type: integer + format: int32 + nullable: true + LocationDto: + type: object + properties: + address: + $ref: '#/components/schemas/LocationAddressDto' + courierCutOffTimes: + type: string + nullable: true + courierAutomaticCallTimes: + type: string + nullable: true + useSameCourierForSameAddress: + type: boolean + courierFailPolicy: + type: integer + format: int32 + timeZoneId: + type: string + nullable: true + priceGroupId: + type: integer + format: int32 + nullable: true + notificationEmail: + type: string + nullable: true + notificationPhone: + type: string + nullable: true + courierVoucherService: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + marketPlaceCallBackSettings: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + importIsActive: + type: boolean + nullable: true + setHandoverOnManifest: + type: boolean + nullable: true + courierServices: + type: array + items: + $ref: '#/components/schemas/LocationCourierServiceDto' + nullable: true + id: + type: integer + format: int32 + name: + type: string + nullable: true + externalLocationId: + type: string + nullable: true + LocationFilter: + type: object + properties: + name: + type: array + items: + type: string + nullable: true + countryId: + type: array + items: + type: integer + format: int32 + nullable: true + countyId: + type: array + items: + type: integer + format: int32 + nullable: true + localityId: + type: array + items: + type: integer + format: int32 + nullable: true + addressText: + type: string + nullable: true + courierId: + type: array + items: + type: integer + format: int32 + nullable: true + ids: + type: array + items: + type: integer + format: int32 + nullable: true + createdAtLe: + type: string + format: date-time + nullable: true + createdAtGe: + type: string + format: date-time + nullable: true + userId: + type: array + items: + type: string + format: uuid + nullable: true + skip: + type: integer + format: int32 + nullable: true + take: + type: integer + format: int32 + nullable: true + orderBy: + type: string + nullable: true + orderByAsc: + type: boolean + ManifestRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + externalLocationId: + type: string + nullable: true + lastPickHour: + type: integer + format: int32 + nullable: true + MarketplaceIntegration: + enum: + - Vivre + type: string + OfflineOrderAddParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/OfflineOrderAddParcelSize' + weight: + type: number + format: double + type: + $ref: '#/components/schemas/ParcelType' + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + OfflineOrderAddParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + OfflineOrderAddRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddParcel' + nullable: true + OrderBarcodes: + type: object + properties: + sequenceNo: + type: integer + format: int32 + barcode: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + OrderOfflineStatus: + enum: + - New + - Success + - Error + - InProgress + - Consolidate + type: string + OrderRequest: + type: object + properties: + parameters: + $ref: '#/components/schemas/OrderRequestParameters' + serviceId: + type: integer + format: int32 + courierId: + $ref: '#/components/schemas/Courier' + shipmentDate: + type: string + format: date-time + shipmentDateEnd: + type: string + format: date-time + addressFrom: + $ref: '#/components/schemas/OrderRequestAddress' + addressTo: + $ref: '#/components/schemas/OrderRequestAddress' + addressReturn: + $ref: '#/components/schemas/OrderRequestAddress' + payment: + $ref: '#/components/schemas/PaymentType' + content: + $ref: '#/components/schemas/OrderRequestContent' + extra: + $ref: '#/components/schemas/OrderRequestExtra' + externalClientLocation: + type: string + nullable: true + externalOrderId: + type: string + nullable: true + metadata: + type: string + nullable: true + sourceChannel: + type: string + nullable: true + observation: + type: string + nullable: true + customAttributes: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + clientSettings: + $ref: '#/components/schemas/OrderRequestClientSettings' + OrderRequestAddress: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + country: + type: string + nullable: true + countryName: + type: string + nullable: true + countyId: + type: integer + format: int32 + nullable: true + localityId: + type: integer + format: int32 + nullable: true + countryId: + type: integer + format: int32 + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + streetType: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNumber: + type: string + nullable: true + postalCode: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + fixedLocationId: + type: string + nullable: true + fixedLocationName: + type: string + nullable: true + courierFixedLocationId: + type: string + nullable: true + OrderRequestClientSettings: + type: object + properties: + trackPageDomainName: + type: string + nullable: true + priceWeight: + type: number + format: double + nullable: true + performanceWeight: + type: number + format: double + nullable: true + performanceMaximumPriceDeviation: + type: number + format: double + nullable: true + performanceMaximumFlatPriceDeviation: + type: number + format: double + nullable: true + performancePreferredMinimumPriceThreshold: + type: number + format: double + nullable: true + clientPreferences: + $ref: '#/components/schemas/ClientPreferences' + senderLocationTimeZoneId: + type: string + nullable: true + doNoSaveGDPRData: + type: boolean + nullable: true + openPackageIsOptional: + type: boolean + nullable: true + saturdayDeliveryIsOptional: + type: boolean + nullable: true + uniqueOrderReferenceId: + type: integer + format: int32 + nullable: true + useInnoshipInsurance: + type: boolean + nullable: true + performanceClientRates: + type: object + additionalProperties: + type: number + format: double + nullable: true + OrderRequestContent: + type: object + properties: + envelopeCount: + type: integer + format: int32 + parcelsCount: + type: integer + format: int32 + palettesCount: + type: integer + format: int32 + totalWeight: + type: number + format: double + contents: + type: string + nullable: true + package: + type: string + nullable: true + oversizedPackage: + type: boolean + parcels: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentParcel' + nullable: true + invoiceNumber: + type: string + nullable: true + invoiceDate: + type: string + format: date-time + nullable: true + invoiceValue: + type: number + format: double + nullable: true + invoiceValueCurrency: + type: string + nullable: true + articles: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentArticle' + nullable: true + OrderRequestContentArticle: + type: object + properties: + description: + type: string + nullable: true + quantity: + type: integer + format: int32 + countryOfOrigin: + type: string + nullable: true + tariff: + type: string + nullable: true + weightNet: + type: number + format: double + weightGross: + type: number + format: double + pricePerPieceAmount: + type: number + format: double + pricePerPieceAmountCurrency: + type: string + nullable: true + sku: + type: string + nullable: true + OrderRequestContentParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/OrderRequestContentParcelSize' + weight: + type: number + format: double + type: + $ref: '#/components/schemas/ParcelType' + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + dangerousGood: + $ref: '#/components/schemas/OrderRequestContentParcelDangerousGood' + OrderRequestContentParcelDangerousGood: + type: object + properties: + productId: + type: string + nullable: true + productDescription: + type: string + nullable: true + productClass: + type: integer + format: int32 + quantityClassification: + type: string + nullable: true + packagingGroupType: + type: string + nullable: true + packagingInstructions: + type: string + nullable: true + chemicalRecordIdentifier: + type: string + nullable: true + OrderRequestContentParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + OrderRequestExtra: + type: object + properties: + bankRepaymentAmount: + type: number + format: double + nullable: true + bankRepaymentCurrency: + type: string + nullable: true + cashOnDeliveryAmount: + type: number + format: double + nullable: true + cashOnDeliveryAmountCurrency: + type: string + nullable: true + cashOnDeliveryPayoutToLocation: + type: boolean + nullable: true + declaredValueAmount: + type: number + format: double + nullable: true + declaredValueAmountCurrency: + type: string + nullable: true + openPackage: + type: boolean + nullable: true + saturdayDelivery: + type: boolean + nullable: true + insuranceAmount: + type: number + format: double + nullable: true + insuranceAmountCurrency: + type: string + nullable: true + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + reference4: + type: string + nullable: true + returnOfDocuments: + type: boolean + nullable: true + returnOfDocumentsComment: + type: string + nullable: true + returnPackage: + type: boolean + nullable: true + returnVoucher: + type: boolean + nullable: true + bank: + type: string + nullable: true + bankIBAN: + type: string + nullable: true + bankAccountHolder: + type: string + nullable: true + customsDeclaration: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclaration' + marketPlace: + $ref: '#/components/schemas/MarketplaceIntegration' + uitCode: + type: string + nullable: true + OrderRequestExtraCustomsDeclaration: + type: object + properties: + exporter: + $ref: '#/components/schemas/OrderRequestAddress' + importer: + $ref: '#/components/schemas/OrderRequestAddress' + exporterTaxId: + type: string + nullable: true + exporterEORI: + type: string + nullable: true + exporterBN: + type: string + nullable: true + importerTaxId: + type: string + nullable: true + importerEORI: + type: string + nullable: true + reason: + $ref: '#/components/schemas/PurposeOfShipment' + incoterm: + type: string + nullable: true + attachments: + type: array + items: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclarationAttachment' + nullable: true + OrderRequestExtraCustomsDeclarationAttachment: + type: object + properties: + name: + type: string + nullable: true + content: + type: string + nullable: true + OrderRequestParameters: + type: object + properties: + async: + type: boolean + getParcelsBarcodes: + type: boolean + includeCourierResponse: + type: boolean + includePriceBreakdown: + type: boolean + includeAddressInResponse: + type: boolean + consolidateOrder: + type: boolean + overwriteLocationAddressWithSenderDetails: + type: boolean + OrderResponse: + type: object + properties: + clientOrderId: + type: integer + format: int32 + nullable: true + courierShipmentId: + type: string + nullable: true + courierShipmentVoucher: + type: string + nullable: true + courier: + type: integer + format: int32 + courierParcelsBarcodes: + type: array + items: + $ref: '#/components/schemas/OrderBarcodes' + nullable: true + price: + $ref: '#/components/schemas/OrderResponsePrice' + calculatedDeliveryDate: + type: string + format: date-time + nullable: true + trackPageUrl: + type: string + nullable: true + courierTrackPageUrl: + type: string + nullable: true + courierResponse: + type: object + additionalProperties: {} + nullable: true + extra: + $ref: '#/components/schemas/OrderRequestExtra' + address: + $ref: '#/components/schemas/OrderResponseAddress' + OrderResponseAddress: + type: object + properties: + from: + $ref: '#/components/schemas/LimitedAddress' + to: + $ref: '#/components/schemas/LimitedAddress' + OrderResponsePrice: + type: object + properties: + amount: + type: number + format: double + vat: + type: number + format: double + totalAmount: + type: number + format: double + currency: + type: string + nullable: true + priceComponents: + type: object + properties: + Km: + type: number + format: double + KmFixed: + type: number + format: double + Envelopes: + type: number + format: double + ContentWeight: + type: number + format: double + Insurance: + type: number + format: double + CashOnDelivery: + type: number + format: double + BankRepayment: + type: number + format: double + FixedExtras: + type: number + format: double + Returns: + type: number + format: double + FuelSurcharge: + type: number + format: double + CourierPrice: + type: number + format: double + OpenPackage: + type: number + format: double + SaturdayDelivery: + type: number + format: double + PriceForExtraParcel: + type: number + format: double + ContentWeightZones: + type: number + format: double + ContentWeightPiecesZones: + type: number + format: double + PickupThirdParty: + type: number + format: double + InnoshipInsurance: + type: number + format: double + ReturnDocument: + type: number + format: double + ReturnPackage: + type: number + format: double + PalletType: + type: number + format: double + FuelSurchargeFlat: + type: number + format: double + ParcelsCount: + type: number + format: double + ExtraCharges: + type: number + format: double + HeaviestParcelWeight: + type: number + format: double + WeightAndLDM: + type: number + format: double + ZonePalletType: + type: number + format: double + CountryPalletType: + type: number + format: double + nullable: true + OrderResponseResponseWithErrors: + type: object + properties: + response: + $ref: '#/components/schemas/OrderResponse' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + nullable: true + correlationId: + type: string + nullable: true + ParcelType: + enum: + - Envelope + - Parcel + - Pallet + type: string + PaymentType: + enum: + - Sender + - Recipient + - ThirdParty + type: string + PickupRequest: + type: object + properties: + courierId: + type: integer + format: int32 + locationId: + type: integer + format: int32 + lastPickupHour: + type: integer + format: int32 + lastPickMinute: + type: integer + format: int32 + PickupResponse: + type: object + properties: + success: + type: boolean + message: + type: string + nullable: true + PostalCodeInfo: + type: object + properties: + countryCode: + type: string + nullable: true + countryName: + type: string + nullable: true + postalCode: + type: string + nullable: true + streets: + type: array + items: + $ref: '#/components/schemas/PostalCodeInfoStreet' + nullable: true + PostalCodeInfoStreet: + type: object + properties: + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countryId: + type: integer + format: int32 + countryName: + type: string + nullable: true + streetName: + type: string + nullable: true + group: + type: string + nullable: true + PostalCodeStructured: + type: object + properties: + countryCode: + type: string + nullable: true + countryId: + type: integer + format: int32 + countryName: + type: string + nullable: true + countryNameLocalized: + type: string + nullable: true + counties: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredCounty' + nullable: true + PostalCodeStructuredCounty: + type: object + properties: + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countyNameLocalized: + type: string + nullable: true + localities: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredLocality' + nullable: true + PostalCodeStructuredLocality: + type: object + properties: + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + localityNameLocalized: + type: string + nullable: true + streets: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredStreet' + nullable: true + PostalCodeStructuredStreet: + type: object + properties: + postalCode: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNameLocalized: + type: string + nullable: true + neighbourhood: + type: string + nullable: true + neighbourhoodLocalized: + type: string + nullable: true + group: + type: string + nullable: true + streetPrefix: + type: string + nullable: true + streetPrefixLocalized: + type: string + nullable: true + PriceRate: + type: object + properties: + carrierId: + type: integer + format: int32 + carrier: + type: string + nullable: true + rateAmount: + type: number + format: double + rateVatAmount: + type: number + format: double + rateTotalAmount: + type: number + format: double + readOnly: true + rateCurrency: + type: string + nullable: true + score: + type: number + format: double + performance: + type: number + format: double + calculatedDeliveryDate: + type: string + format: date-time + nullable: true + deliveryDays: + type: integer + format: int32 + serviceId: + type: integer + format: int32 + service: + type: string + nullable: true + priority: + type: integer + format: int32 + priceComponents: + type: object + properties: + Km: + type: number + format: double + KmFixed: + type: number + format: double + Envelopes: + type: number + format: double + ContentWeight: + type: number + format: double + Insurance: + type: number + format: double + CashOnDelivery: + type: number + format: double + BankRepayment: + type: number + format: double + FixedExtras: + type: number + format: double + Returns: + type: number + format: double + FuelSurcharge: + type: number + format: double + CourierPrice: + type: number + format: double + OpenPackage: + type: number + format: double + SaturdayDelivery: + type: number + format: double + PriceForExtraParcel: + type: number + format: double + ContentWeightZones: + type: number + format: double + ContentWeightPiecesZones: + type: number + format: double + PickupThirdParty: + type: number + format: double + InnoshipInsurance: + type: number + format: double + ReturnDocument: + type: number + format: double + ReturnPackage: + type: number + format: double + PalletType: + type: number + format: double + FuelSurchargeFlat: + type: number + format: double + ParcelsCount: + type: number + format: double + ExtraCharges: + type: number + format: double + HeaviestParcelWeight: + type: number + format: double + WeightAndLDM: + type: number + format: double + ZonePalletType: + type: number + format: double + CountryPalletType: + type: number + format: double + nullable: true + PriceResponse: + type: object + properties: + rates: + type: array + items: + $ref: '#/components/schemas/PriceRate' + nullable: true + correlationId: + type: string + nullable: true + PurposeOfShipment: + enum: + - CommercialShipment + - NonCommercialShipment + type: string + RestrictionCountryCountyDto: + type: object + properties: + countryId: + type: integer + format: int32 + countyId: + type: integer + format: int32 + nullable: true + value: + type: integer + format: int32 + SendSmsRequest: + type: object + properties: + campaignName: + type: string + nullable: true + data: + type: array + items: + $ref: '#/components/schemas/SendSmsRequestItem' + nullable: true + SendSmsRequestItem: + type: object + properties: + phone: + type: array + items: + type: string + nullable: true + message: + type: string + nullable: true + TrackRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + awbList: + type: array + items: + type: string + nullable: true + TrackResponseHistory: + type: object + properties: + clientStatusId: + type: integer + format: int32 + clientStatusDescription: + type: string + nullable: true + eventDate: + type: string + format: date-time + isFinalStatus: + type: boolean + localityName: + type: string + nullable: true + TrackResponseWithReturnInfo: + type: object + properties: + returnAwb: + type: string + nullable: true + returnAwbHistory: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + orderId: + type: integer + format: int32 + externalOrderId: + type: string + nullable: true + correlationId: + type: string + nullable: true + courier: + type: integer + format: int32 + shipmentAwb: + type: string + nullable: true + carrierMeasuredWeight: + type: number + format: double + nullable: true + recipientContactName: + type: string + nullable: true + recipientLocality: + type: string + nullable: true + recipientCountryCode: + type: string + nullable: true + trackUrl: + type: string + nullable: true + currentStatus: + type: string + nullable: true + currentStatusId: + type: integer + format: int32 + dispatchId: + type: string + nullable: true + history: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + cashOnDeliveryHistory: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + UpdateLocationCourierServiceDto: + type: object + properties: + courierId: + type: integer + format: int32 + serviceId: + type: integer + format: int32 + courierServiceRestrictions: + $ref: '#/components/schemas/CourierServiceRestrictionsDto' + useCourierPrices: + type: boolean + nullable: true + mappingTemplateOptionId: + type: string + nullable: true + voucherTemplateOptionId: + type: string + nullable: true + extraServices: + type: object + additionalProperties: + type: boolean + nullable: true + nullable: true + mappingReferences: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + countryDeliveryDays: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + enabled: + type: boolean + nullable: true + localityKm: + type: integer + format: int32 + nullable: true + priceLocalityId: + type: integer + format: int32 + nullable: true + UpdateLocationDto: + type: object + properties: + address: + $ref: '#/components/schemas/LocationAddressDto' + courierCutOffTimes: + type: string + nullable: true + courierAutomaticCallTimes: + type: string + nullable: true + useSameCourierForSameAddress: + type: boolean + courierFailPolicy: + type: integer + format: int32 + timeZoneId: + type: string + nullable: true + priceGroupId: + type: integer + format: int32 + nullable: true + notificationEmail: + type: string + nullable: true + notificationPhone: + type: string + nullable: true + courierVoucherService: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + marketPlaceCallBackSettings: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + importIsActive: + type: boolean + nullable: true + setHandoverOnManifest: + type: boolean + nullable: true + id: + type: integer + format: int32 + name: + type: string + nullable: true + externalLocationId: + type: string + nullable: true + UpdateParcelsRequest: + type: object + properties: + parameters: + $ref: '#/components/schemas/OrderRequestParameters' + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + envelopeCount: + type: integer + format: int32 + parcelsCount: + type: integer + format: int32 + palettesCount: + type: integer + format: int32 + oversizedPackage: + type: boolean + totalWeight: + type: number + format: double + parcels: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentParcel' + nullable: true + UpdateStatusRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + typeId: + type: integer + format: int32 + nullable: true + statusId: + type: integer + format: int32 + actionDateTime: + type: string + format: date-time + UploadDocumentsApiRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + attachments: + type: array + items: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclarationAttachment' + nullable: true + UploadDocumentsApiResponse: + type: object + properties: + success: + type: boolean + message: + type: string + nullable: true + ClientLocationUpdateCourierServicesRequest: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + ClientLocationUpdateCourierServicesRequest1: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + ClientLocationUpdateCourierServicesRequest2: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + ClientLocationUpdateCourierServicesRequest3: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + ClientLocationUpdateCourierServicesRequest4: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + ClientLocationUpdateCourierServicesRequest5: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + ClientLocationUpdateCourierServicesRequest6: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + ClientLocationUpdateCourierServicesRequest7: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + OfflineOrderActivateOrderRequest: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + OfflineOrderActivateOrderRequest1: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + OfflineOrderActivateOrderRequest2: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + OfflineOrderActivateOrderRequest3: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + OfflineOrderUpdateOrderDetailsRequest: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + OfflineOrderUpdateOrderDetailsRequest1: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + OfflineOrderUpdateOrderDetailsRequest2: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + OfflineOrderUpdateOrderDetailsRequest3: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + OfflineOrderAddOrderRequest: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + OfflineOrderAddOrderRequest1: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + OfflineOrderAddOrderRequest2: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + OfflineOrderAddOrderRequest3: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + OrderSimulateMultipleRequest: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + OrderSimulateMultipleRequest1: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + OrderSimulateMultipleRequest2: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + OrderSimulateMultipleRequest3: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + OrderUpdateStatusRequest: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + OrderUpdateStatusRequest1: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + OrderUpdateStatusRequest2: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + OrderUpdateStatusRequest3: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + OrderUpdateCustomAttributesRequest: + type: object + additionalProperties: + type: string + OrderUpdateCustomAttributesRequest1: + type: object + additionalProperties: + type: string + OrderUpdateCustomAttributesRequest2: + type: object + additionalProperties: + type: string + OrderUpdateCustomAttributesRequest3: + type: object + additionalProperties: + type: string + CourierGetAllResponse: + type: array + items: + $ref: '#/components/schemas/AllCouriersResponse' + LocationGetPostalcodesByLocalityIdResponse: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + LocationGetPostalcodesByLocalityId200Response: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + OrderSimulateMultipleResponse: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + OrderSimulateMultiple400Response: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + OrderSimulateMultiple401Response: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + OrderUploadFileResponse: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + TrackOrderCourierAwbWithReturnResponse: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + TrackOrderCourierAwbWithReturn200Response: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + TrackByAwbResponse: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + TrackByAwb200Response: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + securitySchemes: + ApiKeyAuth: + type: apiKey + name: X-Api-Key + in: header +security: + - ApiKeyAuth: + - readAccess + - writeAccess diff --git a/sdks/db/generate-repository-description-cache/fordefi.json b/sdks/db/generate-repository-description-cache/fordefi.json index 39a2082f4c..b691295e12 100644 --- a/sdks/db/generate-repository-description-cache/fordefi.json +++ b/sdks/db/generate-repository-description-cache/fordefi.json @@ -1,3 +1,4 @@ { - "The future of institutional web3 wallets. \n\nFor builders, traders, and operators, Fordefi's comprehensive MPC wallet platform and web3 gateway enables you to securely self-custody your private keys, seamlessly connect to thousands of dApps across any blockchain, protect your workflows with granular policies, and manage your digital asset operations all-in-one place.": "Institutional web3 wallets for builders, traders, and operators. Securely self-custody private keys, connect to dApps, protect workflows with policies, manage digital assets in one place. FORDEFI's {language} SDK generated by Konfig (https://konfigthis.com/)." + "The future of institutional web3 wallets. \n\nFor builders, traders, and operators, Fordefi's comprehensive MPC wallet platform and web3 gateway enables you to securely self-custody your private keys, seamlessly connect to thousands of dApps across any blockchain, protect your workflows with granular policies, and manage your digital asset operations all-in-one place.": "Institutional web3 wallets for builders, traders, and operators. Securely self-custody private keys, connect to dApps, protect workflows with policies, manage digital assets in one place. FORDEFI's {language} SDK generated by Konfig (https://konfigthis.com/).", + "The future of institutional web3 wallets.\n\nFor builders, traders, and operators, Fordefi's comprehensive MPC wallet platform and web3 gateway enables you to securely self-custody your private keys, seamlessly connect to thousands of dApps across any blockchain, protect your workflows with granular policies, and manage your digital asset operations all-in-one place.": "Fordefi: The ultimate MPC wallet for web3, enabling secure key custody, dApp connectivity, policy protection, and asset management in one platform. FORDEFI's {language} SDK generated by Konfig (https://konfigthis.com/)." } \ No newline at end of file diff --git a/sdks/db/generate-repository-description-cache/ilert.json b/sdks/db/generate-repository-description-cache/ilert.json new file mode 100644 index 0000000000..9bf4b49988 --- /dev/null +++ b/sdks/db/generate-repository-description-cache/ilert.json @@ -0,0 +1,3 @@ +{ + "ilert is a SaaS company for alerting, on-call management and incident communication and helps companies to increase their digital uptime. B2C and B2B companies from across the globe, including well-known brands such as Bertelsmann, TeamViewer and REWE, trust ilert to empower their operations teams and ensure everything is running smoothly.": "ilert is a SaaS company for alerting, on-call management and incident communication and helps companies to increase their digital uptime. B2C and B2B companies from across the globe, including well-known brands such as Bertelsmann, TeamViewer and REWE, trust ilert to empower their operations teams and ensure everything is running smoothly." +} \ No newline at end of file diff --git a/sdks/db/generate-repository-description-cache/in-mobile.json b/sdks/db/generate-repository-description-cache/in-mobile.json new file mode 100644 index 0000000000..d2c60da77b --- /dev/null +++ b/sdks/db/generate-repository-description-cache/in-mobile.json @@ -0,0 +1,3 @@ +{ + "inMobile er en SMS-Gateway testet af over 8.000 brugere. Vi håndterer over 150 mio. SMS-beskeder årligt og tilstræber en oppetid på 100%, men sandheden er 99,99%. \n\nUanset, om det drejer sig om at informere dine kunder, medarbejdere eller andre personer, som er vigtige for din virksomhed, gør inMobile det nemt for de rette personer at få besked på det rette tidspunkt. \n\nDu får adgang til en brugervenlig SMS-Gateway og et gennemtestet API, som du nemt kan integrere med dit eget system eller hjemmeside.\n\nØnsker du at høre mere om vores løsning, er du velkommen til at kontakte os på +45 88 33 66 99 eller på mail salg@inmobile.dk\nVi har åbent alle hverdage mellem kl. 8-17": "SMS-Gateway that handles 150M+ messages annually with 99.99% uptime. Easy communication for customers and employees. User-friendly gateway and API for seamless integration. inMobile's {language} SDK generated by Konfig (https://konfigthis.com/)." +} \ No newline at end of file diff --git a/sdks/db/generate-repository-description-cache/innoship.json b/sdks/db/generate-repository-description-cache/innoship.json new file mode 100644 index 0000000000..62459086ae --- /dev/null +++ b/sdks/db/generate-repository-description-cache/innoship.json @@ -0,0 +1,3 @@ +{ + "Innoship is the advanced delivery management platform that helps retailers to improve customer experience by streamlining the delivery process. We combined our eCommerce logistics expertise with all the enterprise features you need to master last-mile customer experience. \n\nBacked by Abris Capital Partners, the ESG transformation specialist private equity investor, Innoship is now part of Alsendo group, the leading eCommerce shipping solutions technologies in the CEE region.\n\nFrom checkout and shipping to tracking, returns and analytics, Innoship helps you safely deliver on promises made to your customers. \n\nEffortless integration, hassle-free delivery\n•\tA simple, one-time integration with the Innoship app allows retailers to access any carrier, local or international.\n•\tExternal markets become readily available with seamless connections to hundreds of carriers in 15+ countries.": "Innoship offers an advanced delivery management platform for retailers, combining eCommerce logistics expertise with enterprise features to optimize last-mile customer experience. Backed by Abris Capital Partners, now part of Alsendo group, it provides effortless integration with diverse carriers for seamless global shipping." +} \ No newline at end of file diff --git a/sdks/db/intermediate-fixed-specs/fordefi/openapi.yaml b/sdks/db/intermediate-fixed-specs/fordefi/openapi.yaml index f50891c656..70aaea002b 100644 --- a/sdks/db/intermediate-fixed-specs/fordefi/openapi.yaml +++ b/sdks/db/intermediate-fixed-specs/fordefi/openapi.yaml @@ -3,7 +3,7 @@ info: title: Fordefi API version: 0.2.0 description: >- - The future of institutional web3 wallets. + The future of institutional web3 wallets. For builders, traders, and operators, Fordefi's comprehensive MPC wallet diff --git a/sdks/db/intermediate-fixed-specs/ilert/openapi.yaml b/sdks/db/intermediate-fixed-specs/ilert/openapi.yaml new file mode 100644 index 0000000000..1ce9d79315 --- /dev/null +++ b/sdks/db/intermediate-fixed-specs/ilert/openapi.yaml @@ -0,0 +1,7270 @@ +openapi: 3.0.0 +info: + version: '' + title: ilert REST API + description: >- + + The ilert API is a + [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API + and provides programmatic access to entities in ilert and lets you easily + integrate ilert with 3rd party tools. If you are looking to develop an + inbound integration (e.g. for a monitoring tool), please use our [Events + API](https://api.ilert.com). + + + The API supports the JSON content type for requests and responses. The + response content type is requested via the HTTP Accept header + (`application/json`). All resources are accessible via https and are located + at `api.ilert.com/api`. + + ## Authentication + + The REST API accepts bearer API tokens. Each user may create API keys using + the ilert web application. Note: Make sure to send the `Bearer ` prefix e.g. + `Bearer APIKEY` when sending api key requests. By default, access to all + resources (using any method) requires the client to be authenticated. + + + ## Team Context + When using API tokens, the currently selected team context of the user will not be taken into account, i.e. list results will always return all entities to which the user has a view permission. When using basic auth credentials the currently selected team context of the user will be used to filter resource results. The context may be overwritten for API key calls using the `team-context` HTTP header. Specifying `0` for ALL teams, `-1` for MY teams or a specific team id e.g. `team-context=901` to fetch results for a certain team. + + ## Errors + + ilert uses HTTP response codes to indicate success or failure of an API + request. Codes in the 2xx range indicate success, codes in the 4xx range + indicate a client error (e.g. a missing required parameter) and codes in the + 5xx range indicate an error with ilert's servers. In case of an error, the + response body contains the following information: + + Attribute | Description + ------------- | ------------- + status | the corresponsing HTTP status code + message | a human readable description of the error + code | error code, used to identify error type + + ## API Versioning + + Changes to our API are always backwards-compatible. To get more information + about our API versioning and historical changes, please take a look here. + x-logo: + url: ./ilert-logo-spaced.png + backgroundColor: '#fafafa' + altText: ilert documentation logo +security: + - apiKey: [] +tags: + - name: Numbers + - name: Integrations + - name: Events + - name: Heartbeats + - name: Series + - name: Users + - name: Contacts + - name: Notification Preferences + - name: Escalation Policies + - name: Schedules + - name: Alert Sources + - name: Alerts + - name: Alert Actions + - name: Support Hours + - name: Log-Entries + - name: Notifications + - name: Connectors + - name: Teams + - name: On-Calls + - name: Maintenance Windows + - name: Incident Templates + - name: Services + - name: Service Outages + - name: Automation Rules + - name: Incidents + - name: Metrics + - name: Metric Data Sources + - name: Status Pages + - name: Reports +paths: + /users/{user-id}: + get: + tags: + - Users + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get the specified user. + responses: + '200': + description: the user object + content: + application/json: + schema: + $ref: '#/components/schemas/User' + put: + tags: + - Users + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: the user object + summary: Update an existing user. + responses: + '200': + description: the updated user + content: + application/json: + schema: + $ref: '#/components/schemas/User' + delete: + tags: + - Users + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Delete the specified user. + responses: + '204': + description: if deletion was successful + /users/{user-id}/contacts/emails: + get: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get a user's emails + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactEmail' + post: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmailPost' + required: true + summary: Create a new email + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmail' + /users/{user-id}/contacts/emails/{id}: + get: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get a specific email + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmail' + put: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmailPost' + summary: Update a user's email + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactEmail' + delete: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified email + responses: + '204': + description: if deletion was successful + /users/{user-id}/contacts/phone-numbers: + get: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get a user's phone numbers + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactPhoneNumber' + post: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumberPost' + required: true + summary: Create a phone number + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumber' + /users/{user-id}/contacts/phone-numbers/{id}: + get: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific phone number + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumber' + put: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumberPost' + summary: Update a user's phone number + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactPhoneNumber' + delete: + tags: + - Contacts + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified phone number + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/alerts: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get alert notification preferences of a user + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationPreferencesAlert' + post: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlertPost' + required: true + summary: Create an alert notification preference + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlert' + /users/{user-id}/notification-preferences/alerts/{id}: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific notification preferences alert + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlert' + put: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlertPost' + summary: Update a user's alert notification preference + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesAlert' + delete: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified notification preferences alert + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/duties: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get duty notification preferences of a user + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationPreferencesDuty' + post: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDutyPost' + required: true + summary: Create a duty notification preference + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDuty' + /users/{user-id}/notification-preferences/duties/{id}: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific notification preferences duty + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDuty' + put: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDutyPost' + summary: Update a user's duty notification preference + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesDuty' + delete: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified notification preferences duty + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/updates: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get update notification preferences of a user + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + post: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdatePost' + required: true + summary: Create an update notification preference + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + /users/{user-id}/notification-preferences/updates/{id}: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific notification preferences update + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + put: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdatePost' + summary: Update a user's update notification preference + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesUpdate' + delete: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified notification preferences update + responses: + '204': + description: if deletion was successful + /users/{user-id}/notification-preferences/subscriptions: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + summary: Get subscription notification preferences of a user + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + post: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscriptionPost' + required: true + summary: Create a subscription notification preference + responses: + '201': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + /users/{user-id}/notification-preferences/subscriptions/{id}: + get: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Get specific notification preferences subscription + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + put: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscriptionPost' + summary: Update a user's subscription notification preference + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationPreferencesSubscription' + delete: + tags: + - Notification Preferences + parameters: + - $ref: '#/components/parameters/user-id-in-path' + - $ref: '#/components/parameters/id' + summary: Delete the user's specified notification preferences subscription + responses: + '204': + description: if deletion was successful + /numbers: + get: + tags: + - Numbers + security: [] + summary: >- + List available phone numbers that ilert uses to send voice and SMS + notifications + responses: + '200': + description: List of phone numbers + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OutboundNumber' + /integrations: + get: + tags: + - Integrations + security: [] + parameters: + - $ref: '#/components/parameters/start-index' + - $ref: '#/components/parameters/max-results' + summary: >- + List available inbound and outbound integrations. Note: this resource is + paginated. + responses: + '200': + description: list of integrations + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Integration' + /users: + get: + tags: + - Users + parameters: + - $ref: '#/components/parameters/start-index' + - $ref: '#/components/parameters/max-results' + summary: List existing users. + responses: + '200': + description: list of users + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + post: + tags: + - Users + summary: Create a new user. Requires ADMIN privileges. + description: | + **Sample request** + + ```json + Request URL: https://api.ilert.com/api/users + + { + "firstName": "John", + "lastName": "Doe", + "email": "john@acme.com", + "position": "Software Engineer", + } + ``` + + **Response** + + ````json + { + "id": 2188373, + "firstName": "John", + "lastName": "Doe", + "email": "john@acme.com", + "position": "Software Engineer", + "timezone": "Europe/Berlin", + "language": "de", + "role": "RESPONDER", + } + ```` + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserPost' + description: the user object + responses: + '201': + description: >- + Created. The URI of the created user entity is included in the + Location header and the user object is included in the body. + content: + application/json: + schema: + $ref: '#/components/schemas/User' + /users/current: + get: + tags: + - Users + summary: Get the currently authenticated user. + responses: + '200': + description: user object + content: + application/json: + schema: + $ref: '#/components/schemas/User' + put: + summary: Update the current user. + tags: + - Users + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserPost' + description: user object + responses: + '200': + description: the updated user + content: + application/json: + schema: + $ref: '#/components/schemas/User' + /alerts: + post: + tags: + - Alerts + summary: >- + Create alerts with customised parameters without requiring events from + monitoring tools that use our Events API. + description: >- + Escalation of the alert will be based on the alert source's escalation + policy or may be overridden by providing a specific escalation policy or + lastly specific set of responders (users), latter will only notify the + user(s) and will not escalate any further. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManualAlert' + description: the alert + required: true + responses: + '201': + description: the created and freshly escalated alert + content: + application/json: + schema: + $ref: '#/components/schemas/Alert' + get: + tags: + - Alerts + summary: >- + List alerts (optionally matching certain criteria that are specified by + query parameters). + description: >- + **Sample URLs** + + * List only alerts that are either in state `PENDING` or `ACCEPTED`:This is an email to + be sent
+ text: + type: string + description: >- + The text body of the email. If none is provided this will be + generated from the HTML. Max size of 2 MB. + + If max size is exceeded, the entire api call will fail. + example: This is the text version of the email + EmailEventListModel: + type: object + additionalProperties: false + properties: + events: + type: array + items: + $ref: '#/components/schemas/EmailEvent' + EmailEvent: + type: object + additionalProperties: false + properties: + messageId: + type: string + description: The id of the message. + example: id1 + eventType: + description: Contains a code for what event type the event is. + example: 3 + oneOf: + - $ref: '#/components/schemas/EmailEventType' + eventTypeDescription: + type: string + description: A text description of the event type + example: Delivered + eventTimestamp: + type: string + description: When the event happened e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + EmailEventType: + type: integer + description: |- + 0 = Undefined + 1 = Clicked + 2 = Complained + 3 = Delivered + 4 = Opened + 5 = PermanentFail + 6 = TemporaryFail + 7 = Unsubscribed + 8 = Queued + 9 = Attempt + x-enumNames: + - Undefined + - Clicked + - Complained + - Delivered + - Opened + - PermanentFail + - TemporaryFail + - Unsubscribed + - Queued + - Attempt + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + ApiPageModelOfEmailTemplateOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfEmailTemplateOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfEmailTemplateOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/EmailTemplateOutputApiModel' + EmailTemplateOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the email template + example: c9b6c7a8-aa22-4a59-b6d5-fdbbeced27bc + name: + type: string + description: The name of the email template + example: My email template + html: + type: string + description: The Html of the email template + example: >- +Hello {name} {lastname}. + This is an email to be sent
+ text: + type: string + description: The text version of the Html + example: Hello {name} This is the text version of the email + subject: + type: string + description: The subject of the email template + example: Hello {lastname} This is the subject of the email + preheader: + type: string + description: The preheader of the email + example: This is the preheader of the email + placeholders: + type: array + description: >- + A list of the placeholders found in the template html, text and + subject. + example: + - '{name}' + - '{lastname}' + items: + type: string + created: + type: string + description: >- + When the email template was created e.g. 2001-02-30T14:50:23Z (UTC + time) + example: '2001-02-30T14:50:23Z' + lastUpdated: + type: string + description: >- + When the email template was last updated e.g. 2001-02-30T14:50:23Z + (UTC time) + example: '2001-02-30T14:50:23Z' + RequestDeletionOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The Id of the Deletion request + example: cf97f715-63d4-41df-92a1-34eb87b866b5 + DeletionRequestCreateInfo: + type: object + additionalProperties: false + properties: + numberInfo: + $ref: '#/components/schemas/NumberInfo' + ApiPageModelOfGroupOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfGroupOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfGroupOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/GroupOutputApiModel' + GroupOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the list + format: guid + example: a80e5daa-1bf9-48ca-b67e-ff79eeab1c39 + name: + type: string + description: The name of the list + example: My list + created: + type: string + description: When the list was created e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + GroupInputApiModel: + type: object + additionalProperties: false + properties: + name: + type: string + ApiPageModelOfRecipientOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfRecipientOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfRecipientOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/RecipientOutputApiModel' + RecipientOutputApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the recipient + format: guid + example: 99e0543f-b059-4127-9b50-c42112f19cc9 + listId: + type: string + description: The id of the list that the recipient belongs to + format: guid + example: 4a5f91d5-3aa4-4419-890e-f7b103406dbf + created: + type: string + description: >- + When the recipient was created e.g. 2001-02-30T14:50:23Z (UTC + time) + example: '2001-02-30T14:50:23Z' + RecipientBaseApiModel: + type: object + x-abstract: true + additionalProperties: false + properties: + externalCreated: + type: string + description: >- + When the recipient was created in an external system e.g. + 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + numberInfo: + $ref: '#/components/schemas/NumberInfo' + fields: + description: The fields to update in the given recipient. + example: + firstname: Friedhelm + lastname: Hillebrand + birthday: '1945-04-30' + custom1: Custom1 + custom2: Custom2 + custom3: Custom3 + custom4: Custom4 + custom5: Custom5 + custom6: Custom6 + email: test@test.dk + zipCode: '8000' + address: testroad 12 + companyName: test company + oneOf: + - $ref: '#/components/schemas/RecipientFieldsCollection' + RecipientFieldsCollection: + type: object + additionalProperties: + type: string + RecipientCreateOrUpdateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + RecipientUpdateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + RecipientCreateApiModel: + allOf: + - $ref: '#/components/schemas/RecipientBaseApiModel' + - type: object + additionalProperties: false + IncomingMessageListModel: + type: object + additionalProperties: false + properties: + messages: + type: array + items: + $ref: '#/components/schemas/IncomingMessage' + IncomingMessage: + type: object + additionalProperties: false + properties: + from: + $ref: '#/components/schemas/IncomingMessageSender' + to: + $ref: '#/components/schemas/IncomingMessageTarget' + text: + type: string + receivedAt: + type: string + example: '2001-02-30T14:50:23Z' + IncomingMessageSender: + type: object + additionalProperties: false + properties: + countryCode: + type: string + phoneNumber: + type: string + rawSource: + type: string + isValidMsisdn: + type: boolean + IncomingMessageTarget: + type: object + additionalProperties: false + properties: + countryCode: + type: string + phoneNumber: + type: string + msisdn: + type: string + SmsOutgoingPostReply: + type: object + additionalProperties: false + properties: + results: + type: array + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateResultModel' + SmsOutgoingApiCreateResultModel: + type: object + additionalProperties: false + properties: + numberDetails: + description: >- + The parsed details about the msisdn provided in the to-field of the + request (msisdn is a number with a countrycode e.g. 4512345678) + oneOf: + - $ref: '#/components/schemas/NumberDetails' + text: + type: string + description: The text message + example: This is a message text to be sent + from: + type: string + description: The sender. + example: PetShop + smsCount: + type: integer + description: >- + The number of sms messages this message will be split into when sent + to the operator. Charging will also be done according to this + number. + format: int32 + example: 1 + messageId: + type: string + description: >- + An optional message id used to identify the message. + + If no message id is provided, a new message id is generated and + assigned to the message. This id must be unique across all messages + created on the same account. + + (In case a previous message has been deleted according to GDPR + deletion rules setup on the specific account, the messageId is + allowed to be reused) + example: PetShop + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2". In case + the message was submitted with encoding "auto", this report will + reveal the final encoding based on the characters in the message + text. + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + example: gsm7 + NumberDetails: + type: object + additionalProperties: false + properties: + countryCode: + type: string + description: The country code part of the msisdn, e.g. 45. + example: '45' + phoneNumber: + type: string + description: The phone number part of the msisdn, e.g. 12345678. + example: '12345678' + rawMsisdn: + type: string + description: >- + The input msisdn in its unaltered format. This is the value provided + when sending the text message. + example: 45 12 34 56 78 + msisdn: + type: string + description: The final cleaned msisdn + example: '4512345678' + isValidMsisdn: + type: boolean + description: True if the input msisdn was valid. + example: true + countryHint: + type: string + description: The country code hint if provided in the request + SmsOutgoingPostRequest: + type: object + additionalProperties: false + required: + - messages + properties: + messages: + type: array + description: >- + A list of the sms messages to be sent. Allowed to contain between 1 + and 250 elements. + maxItems: 250 + minItems: 1 + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateModel' + SmsOutgoingApiCreateModel: + allOf: + - $ref: '#/components/schemas/SmsOutgoingBaseApiModel' + - type: object + additionalProperties: false + required: + - text + - from + properties: + text: + type: string + description: >- + The text message. + + If the max length is exceeded, the message text is truncated and + sent. + maxLength: 10000 + minLength: 1 + example: This is a message text to be sent + from: + type: string + description: >- + The sender. This can either be a 3-11 chars text sender or an up + to 14 digit long sender number. + + If the max length is exceeded, the string is truncated. + minLength: 1 + example: PetShop + flash: + type: boolean + description: >- + If true, the message will be shown as a flash message (also + known as a class0 message) on the target phone. If false, it + will be received as a standard text message. + + Default: false + nullable: true + example: false + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7", "ucs2" or + "auto". + + "gsm7" is the default alfabet for text messages and when using + gsm7, a single sms message can contain 160 characters. If the + length exceeeds 160 characters, the message is actually split up + into parts of 153 characters and charged according to this. + Please note, that a few, specific characters fill up 2 bytes and + count for 2 letters. Ref: + https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along + with smileys. When using this encoding, a single message can + consist of 70 characters. If the message exceeds 70 characters, + the final message is actually split into parts of 67 characters. + + "auto" can be used in case the sender wishes to support + non-roman characters but wants to save the expenses on all the + trafic that only contains gsm characters anyway. + + Default: "gsm7" + example: gsm7 + SmsOutgoingBaseApiModel: + type: object + additionalProperties: false + required: + - to + properties: + to: + type: string + description: >- + The msisdn (country code and number) to send to. (Remember to + include countrycode in all numbers, e.g. 4512345678). + + If max length is exceeded, the entire api call will fail. + maxLength: 20 + minLength: 0 + example: '4512345678' + countryHint: + type: string + description: >- + For optimal phone number validation, we encourage you to provide us + with a country code. This can be the numeric country code (like 44) + or the two-letter suffix (like GB). If this field is empty it is + important that you add the country code (e.g 44) in front of the + phone number in “to”. + maxLength: 50 + minLength: 0 + example: '45' + messageId: + type: string + description: >- + An optional message id used to identify the message. + + If no message id is provided, a new message id is generated and + assigned to the message. This id must be unique across all messages + created on the same account. + + (In case a previous message has been deleted according to GDPR + deletion rules setup on the specific account, the messageId is + allowed to be reused) + + If max length is exceeded, the entire api call will fail. + maxLength: 50 + minLength: 1 + example: PetShop + respectBlacklist: + type: boolean + description: >- + If true, this message will be blocked from sending if the target + number is on the account's blacklist. If false, the message will be + sent no matter blacklist settings. + + Default: true + nullable: true + example: true + validityPeriodInSeconds: + type: integer + description: >- + The validity period in seconds. Minimum is 60 seconds and maximum is + 172800 (48 hours). + + If not specified, the messages is attempted to be delivered in 48 + hours. A typical use of validityPeriod is for messages that makes no + sense to delivery efter er certain time frame, in the case the phone + is turned of, e.g. two factor codes. + + Please note, that messages are still charged even though the + operator is cancelling the delivery attempt due to an exceeded + validity period. + format: int32 + maximum: 172800 + minimum: 60 + nullable: true + example: 90 + statusCallbackUrl: + type: string + description: >- + In case you would like a callback from us when the message is + delivered, you can specify it here and we will call it when we have + new message statuses. + + The callback payload will be an array of status objects. + + Api calls sending messages with the same apikey will be subject to + being bulked together. + maxLength: 500 + minLength: 0 + example: https://[your_domain]/your/desired/path + sendTime: + type: string + description: >- + If set, this defines to time in the future for the message to be + sent. e.g. 2001-02-30T14:50:23Z (UTC time). + example: '2001-02-30T14:50:23Z' + msisdnCooldownInMinutes: + type: integer + description: >- + If set, the message will be cancelled if the same mobile number + already have received a SMS within this specified time period. + + Fx. used to prevent spamming a mobile number. + + Minimum 60 minutes (1 hour) and maximum is 43200 minutes (30 days). + format: int32 + maximum: 43200 + minimum: 60 + nullable: true + example: 1440 + StatusReportListModel: + type: object + additionalProperties: false + properties: + reports: + type: array + items: + $ref: '#/components/schemas/StatusReport' + StatusReport: + type: object + additionalProperties: false + properties: + messageId: + type: string + description: The id of the message. + example: id1 + numberDetails: + $ref: '#/components/schemas/StatusReportNumberDetails' + deliveryInfo: + $ref: '#/components/schemas/DeliveryInfo' + chargeInfo: + $ref: '#/components/schemas/ChargeInfo' + StatusReportNumberDetails: + allOf: + - $ref: '#/components/schemas/NumberDetails' + - type: object + additionalProperties: false + properties: + isAnonymized: + type: boolean + description: Specifies whether the message has been anonymized or not. + example: false + DeliveryInfo: + type: object + additionalProperties: false + properties: + stateCode: + description: >- + Contains a code indicating whether a message is delivered, failed or + cancelled. + example: -1 + oneOf: + - $ref: '#/components/schemas/MessageStateCode' + stateDescription: + type: string + description: A text description of the state code + example: Failed + sendTime: + type: string + description: When the message was sent e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + doneTime: + type: string + description: >- + When the delivery of the message fails, is cancelled, or is + delivered. If the operator does not support reporting the actual + delivery time, this will be the time when the delivery report is + received from the operator. + + In some cases where the message is not sent, this value can be null. + example: '2001-02-30T14:50:23Z' + errorCode: + $ref: '#/components/schemas/ErrorCode' + errorDescription: + type: string + description: A text description of the error code + example: Undeliverable message + MessageStateCode: + type: integer + description: |- + 0 = Unknown + 1 = Delivered + -2 = Cancelled + -1 = Failed + x-enumNames: + - Unknown + - Delivered + - Cancelled + - Failed + enum: + - 0 + - 1 + - -2 + - -1 + ErrorCode: + type: integer + description: "A code describing the error if the state is not Delivered. This property will be absent in case the state is Delivered.\n\r-1 = Undeliverable message\n\r-2 = Msisdn blacklisted by operator\n\r-3 = Invalid mobile number\n\r-4 = Country not available\n\r-5 = Delivery timeout\n\r-6 = Not delivered removed from gateway\n\r-8 = Insufficient funds\n\r-9 = Authorize failed\n\r-10 = Capture failed\n\r-11 = Overcharge donation limit exceeded\n\r-12 = Overcharge type not activated\n\r-13 = Overcharge settings not valid\n\r-14 = Sender name blocked\n\r-15 = Route not available\n\r-16 = Refund not available\n\r-17 = Refund not possible for message\n\r-18 = Refund failed\n\r-19 = Refund not possible for pending message\n\r-20 = Refund not possible for failed message\n\r-21 = Refund failed already refunded\n\r-22 = Delivery timeout before sent\n\r-23 = Message queue full at operator\n\r-80 = Imported from other system\n\r-99 = Submit failed\n\r-100 = Communication error\n\r-101 = Unknown id\n\r-102 = Cancelled\n\r-103 = Unknown error processing message\n\r-104 = Unknown id at operator\n\r-105 = Msisdn blacklisted on account\n\r-106 = Mobile number cooldown\n\r-201 = Suspicious sms content\n\r-202 = Account deactivated\n\r-300 = Pdu sequence incomplete\n\r-301 = Pdu sequence invalid\n\r" + format: integer + example: -1 + ChargeInfo: + type: object + additionalProperties: false + properties: + isCharged: + type: boolean + description: True if the message will be charged. + example: true + smsCount: + type: integer + description: >- + The total sms count in the message. If IsCharged is true, this is + the number of sms'es that will be charged. + format: int32 + example: 2 + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2". In case + the message was submitted with encoding "auto", this report will + reveal the final encoding based on the characters in the message + text. + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + example: gsm7 + SmsOutgoingTemplatePostReply: + type: object + additionalProperties: false + properties: + usedPlaceholderKeys: + type: array + description: A list of used used placeholder keys + example: + - '{name}' + - '{lastname}' + items: + type: string + notUsedPlaceholderKeys: + type: array + description: A list of not used placeholder keys + example: + - '{name}' + - '{lastname}' + items: + type: string + results: + type: array + items: + $ref: '#/components/schemas/SmsOutgoingApiCreateResultModel' + SmsOutgoingTemplatePostRequest: + type: object + additionalProperties: false + required: + - templateId + - messages + properties: + templateId: + type: string + description: The id of the template to use + minLength: 1 + example: ecdcb257-c1e9-4b44-8a4e-f05822372d82 + messages: + type: array + description: >- + A list of the sms messages to be sent. Allowed to contain between 1 + and 250 elements. + maxItems: 250 + minItems: 1 + items: + $ref: '#/components/schemas/SmsOutgoingTemplateApiCreateModel' + SmsOutgoingTemplateApiCreateModel: + allOf: + - $ref: '#/components/schemas/SmsOutgoingBaseApiModel' + - type: object + additionalProperties: false + properties: + placeholders: + description: >- + A key-value list of placeholders to replace in the template + text. Keys must be encapsulated with {}. E.g. {NAME}. + example: + '{name}': Friedhelm + '{lastname}': Hillebrand + oneOf: + - $ref: '#/components/schemas/ApiPlaceholderValueCollection' + SmsOutgoingCancelPostReply: + type: object + additionalProperties: false + properties: + results: + type: array + description: A list of results + items: + $ref: '#/components/schemas/SmsOutgoingCancelPostReplyResultModel' + SmsOutgoingCancelPostReplyResultModel: + type: object + additionalProperties: false + properties: + messageId: + type: string + description: The MessageId of the message that was attempted cancelled. + example: 8fe266b2-56e9-4b5f-938f-cc5e22530721 + resultCode: + description: A value indicating if the message was cancelled. + example: 1 + oneOf: + - $ref: '#/components/schemas/CancelResultCode' + resultDescription: + type: string + description: A description of the result. + example: Success + CancelResultCode: + type: integer + description: |- + 0 = Unknown + 1 = Success + -2 = MessageNotFound + -1 = NotCancelled + x-enumNames: + - Unknown + - Success + - MessageNotFound + - NotCancelled + enum: + - 0 + - 1 + - -2 + - -1 + SmsOutgoingCancelPostRequest: + type: object + additionalProperties: false + required: + - messageIds + properties: + messageIds: + type: array + description: >- + A list of the sms message ids to be cancelled. Allowed to contain + between 1 and 250 elements. + maxItems: 250 + minItems: 1 + example: + - id1 + - id2 + items: + type: string + ApiPageModelOfStandardTextOutputApiModel: + allOf: + - $ref: '#/components/schemas/OutputListApiModelOfStandardTextOutputApiModel' + - type: object + additionalProperties: false + properties: + _links: + $ref: '#/components/schemas/ApiPageLinks' + OutputListApiModelOfStandardTextOutputApiModel: + type: object + additionalProperties: false + properties: + entries: + type: array + items: + $ref: '#/components/schemas/StandardTextOutputApiModel' + StandardTextOutputApiModel: + type: object + additionalProperties: false + properties: + id: + type: string + description: The id of the template + example: c7114ec3-8f89-4e26-8048-686585c1da2a + name: + type: string + description: The name of the template + example: My template + text: + type: string + description: The template text + example: My template text {name} {lastname} + senderName: + type: string + description: The sendername to use with this template + example: My sendername + encoding: + type: string + description: >- + The encoding of the message. Can be either "gsm7" or "ucs2" + + "gsm7" is the default alfabet for text messages and when using gsm7, + a single sms message can contain 160 characters. If the length + exceeeds 160 characters, the message is actually split up into parts + of 153 characters and charged according to this. Please note, that a + few, specific characters fill up 2 bytes and count for 2 letters. + Ref: https://en.wikipedia.org/wiki/GSM_03.38 + + "ucs2"" allows for more non-roman characters to be used along with + smileys. When using this encoding, a single message can consist of + 70 characters. If the message exceeds 70 characters, the final + message is actually split into parts of 67 characters. + example: gsm7 + placeholders: + type: array + description: >- + A list of the placeholders found in the template html, text and + subject. + example: + - '{name}' + - '{lastname}' + items: + type: string + created: + type: string + description: When the template was created e.g. 2001-02-30T14:50:23Z (UTC time) + example: '2001-02-30T14:50:23Z' + lastUpdated: + type: string + description: >- + When the template was last updated e.g. 2001-02-30T14:50:23Z (UTC + time) + example: '2001-02-30T14:50:23Z' + ParsePhoneNumberPostReply: + type: object + additionalProperties: false + properties: + results: + type: array + items: + $ref: '#/components/schemas/NumberDetails' + ParsePhoneNumberPostRequest: + type: object + additionalProperties: false + required: + - numbersToParse + properties: + numbersToParse: + type: array + description: A list of the numbersToParse and country hints to be parsed + minItems: 1 + items: + $ref: '#/components/schemas/RawMsisdnAndCountryHint' + RawMsisdnAndCountryHint: + type: object + additionalProperties: false + properties: + countryHint: + type: string + description: The country part of the msisdn, e.g. 45 or DK. + example: '45' + rawMsisdn: + type: string + description: >- + The input msisdn in its unaltered format. This is the value provided + when sending the text message. + example: +45 12 34 56 78 + securitySchemes: + BasicAuth: + type: http + description: >- + Provide Basic Authentiation with an arbitrary username and your api key + as password, e.g. some_value_to_be_ignored:your_api_key_here + scheme: basic + QueryParameter: + type: apiKey + description: >- + Specify your apikey in the url as + https://api.inmobile.com/some/path?apikey=your_api_key_here. This method + is only recommended if basic authorization is not possible. + name: apikey + in: query +security: + - BasicAuth: [] + - QueryParameter: [] +tags: + - name: Sms - Outgoing + - name: Sms - Incoming + - name: Blacklist + - name: Lists + - name: Gdpr + - name: Email + - name: Email Templates + - name: Templates + - name: Tools diff --git a/sdks/db/intermediate-fixed-specs/innoship/openapi.yaml b/sdks/db/intermediate-fixed-specs/innoship/openapi.yaml new file mode 100644 index 0000000000..73c8ba47f8 --- /dev/null +++ b/sdks/db/intermediate-fixed-specs/innoship/openapi.yaml @@ -0,0 +1,8417 @@ +openapi: 3.0.1 +info: + title: Innoship API + description: Api service implementation (version:6.0.1.503) + termsOfService: https://example.com/terms + contact: + name: Andrei Paul + email: andrei@innoship.ro + license: + name: Use under LICX + url: https://example.com/license + version: v1 +paths: + /api/ClientLocation: + get: + tags: + - ClientLocation + parameters: + - name: countryCode + in: query + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + post: + tags: + - ClientLocation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + text/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + responses: + '200': + description: Success + /api/ClientLocation/{id}: + put: + tags: + - ClientLocation + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + text/json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateLocationDto' + responses: + '200': + description: Success + delete: + tags: + - ClientLocation + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + get: + tags: + - ClientLocation + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/ClientLocation/Summary: + post: + tags: + - ClientLocation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/LocationFilter' + application/json: + schema: + $ref: '#/components/schemas/LocationFilter' + text/json: + schema: + $ref: '#/components/schemas/LocationFilter' + application/*+json: + schema: + $ref: '#/components/schemas/LocationFilter' + responses: + '200': + description: Success + /api/ClientLocation/Validate: + post: + tags: + - ClientLocation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/LocationDto' + application/json: + schema: + $ref: '#/components/schemas/LocationDto' + text/json: + schema: + $ref: '#/components/schemas/LocationDto' + application/*+json: + schema: + $ref: '#/components/schemas/LocationDto' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/Courier: + post: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + application/json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + text/json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + application/*+json: + schema: + $ref: '#/components/schemas/CreateLocationCourierServicesDto' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/Courier/{courierId}: + delete: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - name: force + in: query + schema: + type: boolean + - name: isEmagMarketPlace + in: query + schema: + type: boolean + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/ClientLocation/{locationId}/CourierServices: + put: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: applyToAllLocations + in: query + schema: + type: boolean + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + responses: + '200': + description: Success + patch: + tags: + - ClientLocation + parameters: + - name: locationId + in: path + required: true + schema: + type: integer + format: int32 + - name: applyToAllLocations + in: query + schema: + type: boolean + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateLocationCourierServiceDto' + responses: + '200': + description: Success + /api/Courier/RequestPickup: + post: + tags: + - Courier + summary: Request pickup to courier + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/PickupRequest' + application/json: + schema: + $ref: '#/components/schemas/PickupRequest' + text/json: + schema: + $ref: '#/components/schemas/PickupRequest' + application/*+json: + schema: + $ref: '#/components/schemas/PickupRequest' + responses: + '200': + description: Pickup requested to courier + content: + application/json: + schema: + $ref: '#/components/schemas/PickupResponse' + '400': + description: Unable to request pickup due to errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Courier/All: + get: + tags: + - Courier + summary: Get all couriers + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: List of couriers + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AllCouriersResponse' + '401': + description: Unable to authorize request + /api/Feedback/{from}/{to}: + get: + tags: + - Feedback + parameters: + - name: from + in: path + required: true + schema: + type: string + format: date-time + - name: to + in: path + required: true + schema: + type: string + format: date-time + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Success + /api/Label/by-courier/{courierId}/awb/{awb}: + get: + tags: + - Label + summary: Gets the label for the specified courier awb number + parameters: + - name: courierId + in: path + description: '' + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: '' + required: true + schema: + type: string + - name: type + in: query + description: '' + schema: + type: string + default: PDF + - name: format + in: query + description: '' + schema: + type: string + default: A6 + - name: includeVoucher + in: query + description: '' + schema: + type: boolean + default: false + - name: useFile + in: query + description: '' + schema: + type: boolean + default: true + - name: skipCache + in: query + description: '' + schema: + type: boolean + default: false + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/by-courier/{courierId}/voucher/{awb}: + get: + tags: + - Label + summary: Gets the voucher label for the specified courier awb number + parameters: + - name: courierId + in: path + description: '' + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: '' + required: true + schema: + type: string + - name: type + in: query + description: '' + schema: + type: string + default: PDF + - name: format + in: query + description: '' + schema: + type: string + default: A6 + - name: useFile + in: query + description: '' + schema: + type: boolean + default: true + - name: skipCache + in: query + description: '' + schema: + type: boolean + default: false + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/by-courier/{courierId}/awb/{awb}/parcel/{barcodes}: + get: + tags: + - Label + summary: Gets the label for the specified courier parcel barcode and order awb + parameters: + - name: courierId + in: path + description: '' + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: '' + required: true + schema: + type: string + - name: barcodes + in: path + description: '' + required: true + schema: + type: string + - name: type + in: query + description: '' + schema: + type: string + default: PDF + - name: format + in: query + description: '' + schema: + type: string + default: A6 + - name: useFile + in: query + description: '' + schema: + type: boolean + default: true + - name: skipCache + in: query + description: '' + schema: + type: boolean + default: false + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/bulk: + post: + tags: + - Label + summary: Create bulk labels operation + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + application/json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + text/json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/BulkLabelApiRequest' + responses: + '200': + description: Returns OperationId + '400': + description: Unable to create bulk labels operation due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Label/bulk/{operationId}: + get: + tags: + - Label + summary: Get bulk labels by operationId + parameters: + - name: operationId + in: path + description: '' + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns the label + content: + application/pdf: + schema: + $ref: '#/components/schemas/LabelResponse' + application/json: + schema: + $ref: '#/components/schemas/LabelResponse' + text/html: + schema: + $ref: '#/components/schemas/LabelResponse' + '400': + description: Unable to get the label due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/html: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Location/ClientLocations: + get: + tags: + - Location + responses: + '200': + description: Success + /api/Location/FixedLocation/{id}: + get: + tags: + - Location + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: Success + /api/Location/FixedLocations: + get: + tags: + - Location + parameters: + - name: Courier + in: query + schema: + $ref: '#/components/schemas/Courier' + - name: CountryCode + in: query + schema: + type: string + - name: CountyName + in: query + schema: + type: string + - name: LocalityName + in: query + schema: + type: string + - name: FixedLocationType + in: query + schema: + $ref: '#/components/schemas/FixedLocationType' + - name: ShowInactive + in: query + schema: + type: boolean + - name: RestrictionParcelsCount + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeHeight + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeWidth + in: query + schema: + type: integer + format: int32 + - name: RestrictionSizeLength + in: query + schema: + type: integer + format: int32 + - name: ExternalLocationId + in: query + schema: + type: string + - name: Latitude + in: query + schema: + type: number + format: double + - name: Longitude + in: query + schema: + type: number + format: double + - name: Radius + in: query + schema: + type: number + format: double + responses: + '200': + description: Success + /api/Location/Countries: + get: + tags: + - Location + responses: + '200': + description: Success + /api/Location/Counties/{countryCode}: + get: + tags: + - Location + parameters: + - name: countryCode + in: path + required: true + schema: + type: string + responses: + '200': + description: Success + /api/Location/Localities/{countyId}: + get: + tags: + - Location + parameters: + - name: countyId + in: path + required: true + schema: + type: integer + format: int32 + responses: + '200': + description: Success + /api/Location/Postalcodes/{CountryCode}/{PostalCode}: + get: + tags: + - Location + parameters: + - name: CountryCode + in: path + required: true + schema: + maxLength: 2 + minLength: 2 + pattern: ^[a-z]*$ + type: string + - name: PostalCode + in: path + required: true + schema: + type: string + - name: CourierId + in: query + schema: + type: integer + format: int32 + responses: + '200': + description: Success + content: + text/plain: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + application/json: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + text/json: + schema: + $ref: '#/components/schemas/PostalCodeInfo' + /api/Location/Postalcodes/{LocalityId}: + get: + tags: + - Location + parameters: + - name: LocalityId + in: path + required: true + schema: + type: integer + format: int32 + - name: CourierId + in: query + schema: + type: integer + format: int32 + - name: filter + in: query + schema: + type: string + responses: + '200': + description: Success + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/LocalityPostalCodeInfo' + /api/Location/Postalcodes/Country/{CountryCode}: + get: + tags: + - Location + parameters: + - name: CountryCode + in: path + required: true + schema: + maxLength: 2 + minLength: 2 + pattern: ^[a-z]*$ + type: string + - name: CourierId + in: query + schema: + type: integer + format: int32 + responses: + '200': + description: Success + content: + text/plain: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + application/json: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + text/json: + schema: + $ref: '#/components/schemas/PostalCodeStructured' + /api/Manifest: + post: + tags: + - Manifest + summary: Requests pickup and get manifest id + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/ManifestRequest' + application/json: + schema: + $ref: '#/components/schemas/ManifestRequest' + text/json: + schema: + $ref: '#/components/schemas/ManifestRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ManifestRequest' + responses: + '200': + description: Returns ManifestId + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + get: + tags: + - Manifest + summary: Requests manifest report by id + parameters: + - name: manifestId + in: query + description: '' + schema: + type: integer + format: int64 + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Returns PDF + '400': + description: Unable to process due to validation errors + content: + application/pdf: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + /api/Notifications/sendsms: + post: + tags: + - Notifications + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + application/json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + text/json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/SendSmsRequest' + responses: + '200': + description: Success + /api/OfflineOrder/Activate: + put: + tags: + - OfflineOrder + summary: Activate Offline Orders + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/ActivateOrderApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/OfflineOrder/Edit: + put: + tags: + - OfflineOrder + summary: Edit Offline Orders + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/EditOrderApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/OfflineOrder/Add: + post: + tags: + - OfflineOrder + summary: Add Offline Orders + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddRequest' + responses: + '200': + description: Added successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/Order: + post: + tags: + - Order + summary: Creates a new order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3785363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Creates an new order in the system + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/simulate: + post: + tags: + - Order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3809049+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/validate: + post: + tags: + - Order + summary: Validates a new order request + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3824063+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '201': + description: Creates an new order in the system + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/multiple/simulate: + post: + tags: + - Order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/OrderRequest' + example: + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895363+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + - serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.3895452+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '400': + description: Bad Request + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '401': + description: Unauthorized + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + example: + '1': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + '2': + response: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + errors: null + correlationId: null + /api/Order/file: + post: + tags: + - Order + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/OrderResponseResponseWithErrors' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/{courierId}/awb/{awbNo}: + delete: + tags: + - Order + summary: Deletes an existing order + parameters: + - name: courierId + in: path + description: Courier id + required: true + schema: + type: integer + format: int32 + - name: awbNo + in: path + description: AWB number + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '201': + description: Deletes an existing order from the system + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to delete the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateStatus: + post: + tags: + - Order + summary: Updates orders statuses + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + application/*+json: + schema: + type: array + items: + $ref: '#/components/schemas/UpdateStatusRequest' + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateParcels: + post: + tags: + - Order + summary: Create a new order based on the existing one and cancel the original + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + application/json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + text/json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + application/*+json: + schema: + $ref: '#/components/schemas/UpdateParcelsRequest' + responses: + '200': + description: Creates an new order in the system + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + example: + clientOrderId: 662 + courierShipmentId: '877551879' + courierShipmentVoucher: null + courier: 1 + courierParcelsBarcodes: null + price: + amount: 13.36 + vat: 2.54 + totalAmount: 15.9 + currency: RON + priceComponents: null + calculatedDeliveryDate: '2019-10-03T00:00:00Z' + trackPageUrl: null + courierTrackPageUrl: null + courierResponse: null + extra: null + address: null + '400': + description: Unable to create the order due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UpdateCustomAttributes/{courierId}/awb/{awb}: + post: + tags: + - Order + summary: Updates custom attributes + parameters: + - name: courierId + in: path + description: Courier id + required: true + schema: + type: integer + format: int32 + - name: awb + in: path + description: AWB number + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + type: object + additionalProperties: + type: string + application/json: + schema: + type: object + additionalProperties: + type: string + text/json: + schema: + type: object + additionalProperties: + type: string + application/*+json: + schema: + type: object + additionalProperties: + type: string + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/by-location/{externalLocationId}/{from}/{to}: + get: + tags: + - Order + summary: Retrieve orders by externalLocationId with dates filter + parameters: + - name: externalLocationId + in: path + description: External Location Id + required: true + schema: + type: string + - name: from + in: path + description: From date + required: true + schema: + type: string + format: date-time + - name: to + in: path + description: To date + required: true + schema: + type: string + format: date-time + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '200': + description: Request was processed successfully + '400': + description: Unable to process due to validation errors + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/ReturnAwbInfo/{courierId}/{returnAwb}: + get: + tags: + - Order + parameters: + - name: courierId + in: path + required: true + schema: + type: integer + format: int32 + - name: returnAwb + in: path + required: true + schema: + type: string + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + responses: + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Order/UploadDocuments: + post: + tags: + - Order + summary: UploadDocuments + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + application/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + text/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiRequest' + responses: + '200': + description: Document uploaded + content: + application/json: + schema: + $ref: '#/components/schemas/UploadDocumentsApiResponse' + '400': + description: Unable to upload documents + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Price: + post: + tags: + - Price + summary: Gets the prices for the specified request + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + text/json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + application/*+json: + schema: + $ref: '#/components/schemas/OrderRequest' + example: + serviceId: 1 + courierId: null + shipmentDate: '2024-03-29T22:08:02.4002507+00:00' + shipmentDateEnd: '0001-01-01T00:00:00+00:00' + addressFrom: null + addressTo: + name: Name of recipient + contactPerson: Contact for recipient + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Adress text 10 + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + addressReturn: null + payment: Sender + content: + envelopeCount: 0 + parcelsCount: 1 + palettesCount: 0 + totalWeight: 1 + contents: t-shirt + package: box + oversizedPackage: false + parcels: + - sequenceNo: 1 + size: + width: 20 + height: 50 + length: 20 + weight: 1 + type: Parcel + reference1: invoice for order 222 + reference2: null + reference3: null + customerBarcode: null + dangerousGood: null + invoiceNumber: invoice 0001 + invoiceDate: '0001-01-01T00:00:00Z' + invoiceValue: 13 + invoiceValueCurrency: EUR + articles: + - quantity: 1 + description: article description + countryOfOrigin: BG + tariff: tariff + weightNet: 1 + weightGross: 1 + pricePerPieceAmount: 13 + pricePerPieceAmountCurrency: EUR + sku: '1' + extra: + bankRepaymentAmount: 32.12 + bankRepaymentCurrency: null + cashOnDeliveryAmount: null + cashOnDeliveryAmountCurrency: null + cashOnDeliveryPayoutToLocation: null + declaredValueAmount: null + declaredValueAmountCurrency: null + openPackage: true + saturdayDelivery: null + insuranceAmount: null + insuranceAmountCurrency: null + reference1: null + reference2: null + reference3: null + reference4: null + returnOfDocuments: null + returnOfDocumentsComment: null + returnPackage: null + returnVoucher: null + bank: null + bankIBAN: null + bankAccountHolder: null + customsDeclaration: + exporter: + name: Name of Exporter + contactPerson: Contact for Exporter + country: BG + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Varna + localityName: Varna + addressText: Exporter Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '1234' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + importer: + name: Name of Importer + contactPerson: Contact for Importer + country: RO + countryName: null + countyId: null + localityId: null + countryId: null + countyName: Bucuresti + localityName: Bucuresti + addressText: Importer Adress + streetType: null + streetName: null + streetNumber: null + postalCode: '123456' + phone: '+40734123456' + email: email@emailserver.com + fixedLocationId: null + fixedLocationName: null + courierFixedLocationId: null + exporterTaxId: exporter taxId + exporterEORI: eori 12345 + exporterBN: BN + importerTaxId: importer taxId + importerEORI: eori 54321 + reason: NonCommercialShipment + incoterm: incoterm + attachments: + - name: file + content: text + marketPlace: null + uitCode: null + parameters: + async: true + getParcelsBarcodes: false + includeCourierResponse: false + includePriceBreakdown: false + includeAddressInResponse: false + consolidateOrder: false + overwriteLocationAddressWithSenderDetails: false + externalClientLocation: RO + externalOrderId: null + metadata: extra data information + sourceChannel: Swagger + observation: Call one hour before + customAttributes: null + clientSettings: null + responses: + '201': + description: List of prices for eligible couriers + content: + application/json: + schema: + $ref: '#/components/schemas/PriceResponse' + '400': + description: Unable to get prices due to validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unable to authorize request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Track/by-awb/with-return: + post: + tags: + - Track + summary: Track by Order Courier AWB with return info + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/json: + schema: + $ref: '#/components/schemas/TrackRequest' + text/json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TrackRequest' + responses: + '200': + description: Success + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Track/return/by-awb: + post: + tags: + - Track + summary: Track Retrun by Courier AWB + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/json: + schema: + $ref: '#/components/schemas/TrackRequest' + text/json: + schema: + $ref: '#/components/schemas/TrackRequest' + application/*+json: + schema: + $ref: '#/components/schemas/TrackRequest' + responses: + '200': + description: Success + content: + text/plain: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + text/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrackResponseWithReturnInfo' + '400': + description: Bad Request + content: + text/plain: + schema: + $ref: '#/components/schemas/ErrorResponse' + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /api/Voucher/Create: + post: + tags: + - Voucher + summary: Create Voucher + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + application/json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + text/json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/CreateVoucherApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request + /api/Voucher/Activate: + post: + tags: + - Voucher + summary: Activate Voucher + parameters: + - name: api-version + in: query + description: The requested API version + required: true + schema: + type: string + default: '1.0' + - name: api-version + in: header + description: The requested API version + schema: + type: string + default: '1.0' + requestBody: + description: '' + content: + application/json-patch+json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + application/json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + text/json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + application/*+json: + schema: + $ref: '#/components/schemas/ActivateVoucherApiRequest' + responses: + '200': + description: Activated successfully + '400': + description: Unable to process due to validation errors + '401': + description: Unable to authorize request +components: + schemas: + ActivateAddress: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + country: + type: string + nullable: true + countryName: + type: string + nullable: true + countyId: + type: integer + format: int32 + nullable: true + localityId: + type: integer + format: int32 + nullable: true + countryId: + type: integer + format: int32 + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + postalCode: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + fixedLocationId: + type: string + nullable: true + fixedLocationName: + type: string + nullable: true + courierFixedLocationId: + type: string + nullable: true + additionalProperties: false + ActivateOrderApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + shipmentDate: + type: string + format: date-time + nullable: true + shipmentDateEnd: + type: string + format: date-time + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/ActivateOrderParcel' + nullable: true + addressFrom: + $ref: '#/components/schemas/ActivateAddress' + addressTo: + $ref: '#/components/schemas/ActivateAddress' + additionalProperties: false + ActivateOrderParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/ActivateOrderParcelSize' + weight: + type: number + format: double + additionalProperties: false + ActivateOrderParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + additionalProperties: false + ActivateVoucherApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + courierShipmentVoucher: + type: string + nullable: true + additionalProperties: false + AllCouriersResponse: + type: object + properties: + courierId: + type: integer + format: int32 + courier: + type: string + nullable: true + courierDisplayName: + type: string + nullable: true + additionalProperties: false + BulkLabelApiRequest: + type: object + properties: + labelType: + $ref: '#/components/schemas/LabelType' + labelFormat: + $ref: '#/components/schemas/LabelFormat' + useFile: + type: boolean + includeVoucher: + type: boolean + awBs: + type: array + items: + $ref: '#/components/schemas/BulkLabelApiRequestItem' + nullable: true + additionalProperties: false + BulkLabelApiRequestItem: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + typeId: + type: integer + format: int32 + courierShipmentId: + type: string + nullable: true + additionalProperties: false + ClientPreferences: + type: object + properties: + preferredLabel: + $ref: '#/components/schemas/LabelFormat' + preferredLocationId: + type: integer + format: int32 + nullable: true + orderColumns: + type: array + items: + type: string + nullable: true + pickupColumns: + type: array + items: + type: string + nullable: true + returnColumns: + type: array + items: + type: string + nullable: true + additionalProperties: false + Courier: + enum: + - Cargus + - DPD + - FanCourier + - GLS + - Nemo + - Sameday + - ExpressOne + - ECont + - TeamCourier + - DHL + - PostaRomana + - PostaPanduri + - GLS_HU + - DragonStar + - Coletaria + - Bookurier + - Asendia + - TNT + - DPD_BG + - GLS_HR + - GLS_CZ + - GLS_SI + - GLS_SK + - InOut + - StackCurier + - GebruderWeiss + - Pallex + - GT + - CourierManager + - GLS_IT + - ECourier + - Unimasters + - TCE + - TransilvaniaPost + - BGPost + - Evropat + - SMPCourier + - DHL_DE + - Raben + - Memex + - PTTExpress + - XDCourier + - IL + - NovaPosta + - PinkPost + - Strongo + - DHL_Paket + - DHL_Parcel + - BeeFast + - InPost + - KLG + - Schenker + - Packageez + - Kargo + - SundayCourier + - PocztaPolska + - Sinapseria + - UPS + - DPD_HR + - DPD_SI + - NovaPoshtaGlobal + - ALD + - ProNatur + - DPD_HU + - GLS_PL + - Futar24h + - SlovakParcelService + - DPD_DE + - VanOnGo + - CeskaPosta + - DPD_SK + - SolAir + - PostaSlovenije + - DPD_PL + - Agil24 + - OrlenPackza + - Speedex + - FedEx + - DPD_UK + - PPL + - EColet + - ACS + - Helpship + - DPD_CZ + - MagyarPosta + - EVRI + - FedEx_PL + - KuehneNagel + - Sameday_BG + - Sameday_HU + - FanDelivery + - Seur + - Correos + - Couriera + - ChopChop + - InPost_ES + - FanCourierMoldova + - GLS_DE + - Kurier123 + - Dachser + - CTT_PT + - DPD_AT + - PostNord + - Pharmalink + - MRW + - Eurolog + - IDLogistics + - GLS_DK + - RoyalMail + - FanInternational + - Go4 + - InPost_IT + - AmazonShipping_IT + - TNT_IT + - Posta_SK + - Posta_AT + - GLS_ES + - LithuanianPost + - DHL_Parcel_DE + - DPD_LT + - ExpressOne_BG + - FoxPost + - Posta_NL + - InnoshipMocked + type: string + CourierServiceRestrictionsDto: + type: object + properties: + piecesCountMin: + type: integer + format: int32 + nullable: true + piecesCountMax: + type: integer + format: int32 + nullable: true + weightMin: + type: integer + format: int32 + nullable: true + weightMax: + type: integer + format: int32 + nullable: true + parcelWeightMin: + type: integer + format: int32 + nullable: true + parcelWeightMax: + type: integer + format: int32 + nullable: true + widthMin: + type: integer + format: int32 + nullable: true + widthMax: + type: integer + format: int32 + nullable: true + heightMin: + type: integer + format: int32 + nullable: true + heightMax: + type: integer + format: int32 + nullable: true + lengthMin: + type: integer + format: int32 + nullable: true + lengthMax: + type: integer + format: int32 + nullable: true + orderCountMax: + type: integer + format: int32 + nullable: true + orderPiecesCountMax: + type: integer + format: int32 + nullable: true + orderLocationCountMax: + type: array + items: + $ref: '#/components/schemas/RestrictionCountryCountyDto' + nullable: true + orderLocationPiecesCountMax: + type: array + items: + $ref: '#/components/schemas/RestrictionCountryCountyDto' + nullable: true + allowsCOD: + type: boolean + nullable: true + allowsBankCOD: + type: boolean + nullable: true + allowsNoSizeForParcels: + type: boolean + nullable: true + allowsPickUp: + type: boolean + nullable: true + allowsOrder: + type: boolean + nullable: true + allowsEmptyPostalCode: + type: boolean + nullable: true + allowsReturnDocument: + type: boolean + nullable: true + allowsReturnPackage: + type: boolean + nullable: true + allowsOversized: + type: boolean + nullable: true + allowsInsurance: + type: boolean + nullable: true + allowsSaturdayDelivery: + type: boolean + nullable: true + allowsOpenPackage: + type: boolean + nullable: true + courierCutOffTime: + type: string + format: date-span + nullable: true + additionalProperties: false + CreateLocationCourierServicesDto: + type: object + properties: + courierId: + type: integer + format: int32 + isEmagMarketPlace: + type: boolean + additionalProperties: false + CreateVoucherApiRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + voucherCourier: + $ref: '#/components/schemas/Courier' + insuranceAmount: + type: number + format: double + insuranceCurrency: + type: string + nullable: true + additionalProperties: false + EditOrderApiRequest: + type: object + properties: + offlineStatusId: + $ref: '#/components/schemas/OrderOfflineStatus' + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + shipmentDate: + type: string + format: date-time + nullable: true + shipmentDateEnd: + type: string + format: date-time + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/ActivateOrderParcel' + nullable: true + addressFrom: + $ref: '#/components/schemas/ActivateAddress' + addressTo: + $ref: '#/components/schemas/ActivateAddress' + additionalProperties: false + Error: + type: object + properties: + context: + type: string + nullable: true + message: + type: string + nullable: true + details: + type: array + items: + $ref: '#/components/schemas/Error' + nullable: true + additionalProperties: false + ErrorResponse: + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorResponseItem' + nullable: true + correlationId: + type: string + nullable: true + additionalProperties: false + ErrorResponseItem: + type: object + properties: + message: + type: string + nullable: true + details: + type: array + items: + type: string + nullable: true + additionalProperties: false + FixedLocationType: + enum: + - Locker + - PickupPoint + type: string + LabelFormat: + enum: + - A4 + - A6 + - T_85x85 + - A6_300dpi + - A4_4xA6 + - A6_10x9 + type: string + LabelResponse: + type: object + properties: + courier: + type: integer + format: int32 + contents: + type: string + nullable: true + labels: + type: array + items: + type: string + nullable: true + additionalProperties: false + LabelType: + enum: + - Pdf + - Html + - Zpl + type: string + LimitedAddress: + type: object + properties: + country: + type: string + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + postalCode: + type: string + nullable: true + additionalProperties: false + LocalityPostalCodeInfo: + type: object + properties: + localityId: + type: integer + format: int32 + postalCode: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNameLocalized: + type: string + nullable: true + neighbourhoodName: + type: string + nullable: true + neighbourhoodNameLocalized: + type: string + nullable: true + streetPrefix: + type: string + nullable: true + streetPrefixLocalized: + type: string + nullable: true + additionalProperties: false + LocationAddressDto: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + postalCode: + type: string + nullable: true + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countryCode: + type: string + nullable: true + countryName: + type: string + nullable: true + ignoreLocalityId: + type: boolean + latitude: + type: number + format: double + nullable: true + longitude: + type: number + format: double + nullable: true + additionalProperties: false + LocationCourierServiceDto: + type: object + properties: + courierId: + type: integer + format: int32 + courier: + type: string + nullable: true + courierDisplayName: + type: string + nullable: true + serviceId: + type: integer + format: int32 + service: + type: string + nullable: true + serviceGroupId: + type: integer + format: int32 + serviceGroupName: + type: string + nullable: true + hasValidationError: + type: boolean + nullable: true + courierServiceRestrictions: + $ref: '#/components/schemas/CourierServiceRestrictionsDto' + useCourierPrices: + type: boolean + nullable: true + mappingTemplateOptionId: + type: string + nullable: true + voucherTemplateOptionId: + type: string + nullable: true + extraServices: + type: object + additionalProperties: + type: boolean + nullable: true + nullable: true + mappingReferences: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + countryDeliveryDays: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + enabled: + type: boolean + nullable: true + localityKm: + type: integer + format: int32 + nullable: true + priceLocalityId: + type: integer + format: int32 + nullable: true + additionalProperties: false + LocationDto: + type: object + properties: + address: + $ref: '#/components/schemas/LocationAddressDto' + courierCutOffTimes: + type: string + nullable: true + courierAutomaticCallTimes: + type: string + nullable: true + useSameCourierForSameAddress: + type: boolean + courierFailPolicy: + type: integer + format: int32 + timeZoneId: + type: string + nullable: true + priceGroupId: + type: integer + format: int32 + nullable: true + notificationEmail: + type: string + nullable: true + notificationPhone: + type: string + nullable: true + courierVoucherService: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + marketPlaceCallBackSettings: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + importIsActive: + type: boolean + nullable: true + setHandoverOnManifest: + type: boolean + nullable: true + courierServices: + type: array + items: + $ref: '#/components/schemas/LocationCourierServiceDto' + nullable: true + id: + type: integer + format: int32 + name: + type: string + nullable: true + externalLocationId: + type: string + nullable: true + additionalProperties: false + LocationFilter: + type: object + properties: + name: + type: array + items: + type: string + nullable: true + countryId: + type: array + items: + type: integer + format: int32 + nullable: true + countyId: + type: array + items: + type: integer + format: int32 + nullable: true + localityId: + type: array + items: + type: integer + format: int32 + nullable: true + addressText: + type: string + nullable: true + courierId: + type: array + items: + type: integer + format: int32 + nullable: true + ids: + type: array + items: + type: integer + format: int32 + nullable: true + createdAtLe: + type: string + format: date-time + nullable: true + createdAtGe: + type: string + format: date-time + nullable: true + userId: + type: array + items: + type: string + format: uuid + nullable: true + skip: + type: integer + format: int32 + nullable: true + take: + type: integer + format: int32 + nullable: true + orderBy: + type: string + nullable: true + orderByAsc: + type: boolean + additionalProperties: false + ManifestRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + externalLocationId: + type: string + nullable: true + lastPickHour: + type: integer + format: int32 + nullable: true + additionalProperties: false + MarketplaceIntegration: + enum: + - Vivre + type: string + OfflineOrderAddParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/OfflineOrderAddParcelSize' + weight: + type: number + format: double + type: + $ref: '#/components/schemas/ParcelType' + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + additionalProperties: false + OfflineOrderAddParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + additionalProperties: false + OfflineOrderAddRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + parcels: + type: array + items: + $ref: '#/components/schemas/OfflineOrderAddParcel' + nullable: true + additionalProperties: false + OrderBarcodes: + type: object + properties: + sequenceNo: + type: integer + format: int32 + barcode: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + additionalProperties: false + OrderOfflineStatus: + enum: + - New + - Success + - Error + - InProgress + - Consolidate + type: string + OrderRequest: + type: object + properties: + serviceId: + type: integer + format: int32 + courierId: + $ref: '#/components/schemas/Courier' + shipmentDate: + type: string + format: date-time + shipmentDateEnd: + type: string + format: date-time + addressFrom: + $ref: '#/components/schemas/OrderRequestAddress' + addressTo: + $ref: '#/components/schemas/OrderRequestAddress' + addressReturn: + $ref: '#/components/schemas/OrderRequestAddress' + payment: + $ref: '#/components/schemas/PaymentType' + content: + $ref: '#/components/schemas/OrderRequestContent' + extra: + $ref: '#/components/schemas/OrderRequestExtra' + parameters: + $ref: '#/components/schemas/OrderRequestParameters' + externalClientLocation: + type: string + nullable: true + externalOrderId: + type: string + nullable: true + metadata: + type: string + nullable: true + sourceChannel: + type: string + nullable: true + observation: + type: string + nullable: true + customAttributes: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + clientSettings: + $ref: '#/components/schemas/OrderRequestClientSettings' + additionalProperties: false + OrderRequestAddress: + type: object + properties: + name: + type: string + nullable: true + contactPerson: + type: string + nullable: true + country: + type: string + nullable: true + countryName: + type: string + nullable: true + countyId: + type: integer + format: int32 + nullable: true + localityId: + type: integer + format: int32 + nullable: true + countryId: + type: integer + format: int32 + nullable: true + countyName: + type: string + nullable: true + localityName: + type: string + nullable: true + addressText: + type: string + nullable: true + streetType: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNumber: + type: string + nullable: true + postalCode: + type: string + nullable: true + phone: + type: string + nullable: true + email: + type: string + nullable: true + fixedLocationId: + type: string + nullable: true + fixedLocationName: + type: string + nullable: true + courierFixedLocationId: + type: string + nullable: true + additionalProperties: false + OrderRequestClientSettings: + type: object + properties: + trackPageDomainName: + type: string + nullable: true + priceWeight: + type: number + format: double + nullable: true + performanceWeight: + type: number + format: double + nullable: true + performanceMaximumPriceDeviation: + type: number + format: double + nullable: true + performanceMaximumFlatPriceDeviation: + type: number + format: double + nullable: true + performancePreferredMinimumPriceThreshold: + type: number + format: double + nullable: true + clientPreferences: + $ref: '#/components/schemas/ClientPreferences' + senderLocationTimeZoneId: + type: string + nullable: true + doNoSaveGDPRData: + type: boolean + nullable: true + openPackageIsOptional: + type: boolean + nullable: true + saturdayDeliveryIsOptional: + type: boolean + nullable: true + uniqueOrderReferenceId: + type: integer + format: int32 + nullable: true + useInnoshipInsurance: + type: boolean + nullable: true + performanceClientRates: + type: object + additionalProperties: + type: number + format: double + nullable: true + additionalProperties: false + OrderRequestContent: + type: object + properties: + envelopeCount: + type: integer + format: int32 + parcelsCount: + type: integer + format: int32 + palettesCount: + type: integer + format: int32 + totalWeight: + type: number + format: double + contents: + type: string + nullable: true + package: + type: string + nullable: true + oversizedPackage: + type: boolean + parcels: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentParcel' + nullable: true + invoiceNumber: + type: string + nullable: true + invoiceDate: + type: string + format: date-time + nullable: true + invoiceValue: + type: number + format: double + nullable: true + invoiceValueCurrency: + type: string + nullable: true + articles: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentArticle' + nullable: true + additionalProperties: false + OrderRequestContentArticle: + type: object + properties: + quantity: + type: integer + format: int32 + description: + type: string + nullable: true + countryOfOrigin: + type: string + nullable: true + tariff: + type: string + nullable: true + weightNet: + type: number + format: double + weightGross: + type: number + format: double + pricePerPieceAmount: + type: number + format: double + pricePerPieceAmountCurrency: + type: string + nullable: true + sku: + type: string + nullable: true + additionalProperties: false + OrderRequestContentParcel: + type: object + properties: + sequenceNo: + type: integer + format: int32 + size: + $ref: '#/components/schemas/OrderRequestContentParcelSize' + weight: + type: number + format: double + type: + $ref: '#/components/schemas/ParcelType' + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + customerBarcode: + type: string + nullable: true + dangerousGood: + $ref: '#/components/schemas/OrderRequestContentParcelDangerousGood' + additionalProperties: false + OrderRequestContentParcelDangerousGood: + type: object + properties: + productId: + type: string + nullable: true + productDescription: + type: string + nullable: true + productClass: + type: integer + format: int32 + quantityClassification: + type: string + nullable: true + packagingGroupType: + type: string + nullable: true + packagingInstructions: + type: string + nullable: true + chemicalRecordIdentifier: + type: string + nullable: true + additionalProperties: false + OrderRequestContentParcelSize: + type: object + properties: + width: + type: number + format: double + height: + type: number + format: double + length: + type: number + format: double + additionalProperties: false + OrderRequestExtra: + type: object + properties: + bankRepaymentAmount: + type: number + format: double + nullable: true + bankRepaymentCurrency: + type: string + nullable: true + cashOnDeliveryAmount: + type: number + format: double + nullable: true + cashOnDeliveryAmountCurrency: + type: string + nullable: true + cashOnDeliveryPayoutToLocation: + type: boolean + nullable: true + declaredValueAmount: + type: number + format: double + nullable: true + declaredValueAmountCurrency: + type: string + nullable: true + openPackage: + type: boolean + nullable: true + saturdayDelivery: + type: boolean + nullable: true + insuranceAmount: + type: number + format: double + nullable: true + insuranceAmountCurrency: + type: string + nullable: true + reference1: + type: string + nullable: true + reference2: + type: string + nullable: true + reference3: + type: string + nullable: true + reference4: + type: string + nullable: true + returnOfDocuments: + type: boolean + nullable: true + returnOfDocumentsComment: + type: string + nullable: true + returnPackage: + type: boolean + nullable: true + returnVoucher: + type: boolean + nullable: true + bank: + type: string + nullable: true + bankIBAN: + type: string + nullable: true + bankAccountHolder: + type: string + nullable: true + customsDeclaration: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclaration' + marketPlace: + $ref: '#/components/schemas/MarketplaceIntegration' + uitCode: + type: string + nullable: true + additionalProperties: false + OrderRequestExtraCustomsDeclaration: + type: object + properties: + exporter: + $ref: '#/components/schemas/OrderRequestAddress' + importer: + $ref: '#/components/schemas/OrderRequestAddress' + exporterTaxId: + type: string + nullable: true + exporterEORI: + type: string + nullable: true + exporterBN: + type: string + nullable: true + importerTaxId: + type: string + nullable: true + importerEORI: + type: string + nullable: true + reason: + $ref: '#/components/schemas/PurposeOfShipment' + incoterm: + type: string + nullable: true + attachments: + type: array + items: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclarationAttachment' + nullable: true + additionalProperties: false + OrderRequestExtraCustomsDeclarationAttachment: + type: object + properties: + name: + type: string + nullable: true + content: + type: string + nullable: true + additionalProperties: false + OrderRequestParameters: + type: object + properties: + async: + type: boolean + getParcelsBarcodes: + type: boolean + includeCourierResponse: + type: boolean + includePriceBreakdown: + type: boolean + includeAddressInResponse: + type: boolean + consolidateOrder: + type: boolean + overwriteLocationAddressWithSenderDetails: + type: boolean + additionalProperties: false + OrderResponse: + type: object + properties: + clientOrderId: + type: integer + format: int32 + nullable: true + courierShipmentId: + type: string + nullable: true + courierShipmentVoucher: + type: string + nullable: true + courier: + type: integer + format: int32 + courierParcelsBarcodes: + type: array + items: + $ref: '#/components/schemas/OrderBarcodes' + nullable: true + price: + $ref: '#/components/schemas/OrderResponsePrice' + calculatedDeliveryDate: + type: string + format: date-time + nullable: true + trackPageUrl: + type: string + nullable: true + courierTrackPageUrl: + type: string + nullable: true + courierResponse: + type: object + additionalProperties: {} + nullable: true + extra: + $ref: '#/components/schemas/OrderRequestExtra' + address: + $ref: '#/components/schemas/OrderResponseAddress' + additionalProperties: false + OrderResponseAddress: + type: object + properties: + from: + $ref: '#/components/schemas/LimitedAddress' + to: + $ref: '#/components/schemas/LimitedAddress' + additionalProperties: false + OrderResponsePrice: + type: object + properties: + amount: + type: number + format: double + vat: + type: number + format: double + totalAmount: + type: number + format: double + currency: + type: string + nullable: true + priceComponents: + type: object + properties: + Km: + type: number + format: double + KmFixed: + type: number + format: double + Envelopes: + type: number + format: double + ContentWeight: + type: number + format: double + Insurance: + type: number + format: double + CashOnDelivery: + type: number + format: double + BankRepayment: + type: number + format: double + FixedExtras: + type: number + format: double + Returns: + type: number + format: double + FuelSurcharge: + type: number + format: double + CourierPrice: + type: number + format: double + OpenPackage: + type: number + format: double + SaturdayDelivery: + type: number + format: double + PriceForExtraParcel: + type: number + format: double + ContentWeightZones: + type: number + format: double + ContentWeightPiecesZones: + type: number + format: double + PickupThirdParty: + type: number + format: double + InnoshipInsurance: + type: number + format: double + ReturnDocument: + type: number + format: double + ReturnPackage: + type: number + format: double + PalletType: + type: number + format: double + FuelSurchargeFlat: + type: number + format: double + ParcelsCount: + type: number + format: double + ExtraCharges: + type: number + format: double + HeaviestParcelWeight: + type: number + format: double + WeightAndLDM: + type: number + format: double + ZonePalletType: + type: number + format: double + CountryPalletType: + type: number + format: double + additionalProperties: false + nullable: true + additionalProperties: false + OrderResponseResponseWithErrors: + type: object + properties: + response: + $ref: '#/components/schemas/OrderResponse' + errors: + type: array + items: + $ref: '#/components/schemas/Error' + nullable: true + correlationId: + type: string + nullable: true + additionalProperties: false + ParcelType: + enum: + - Envelope + - Parcel + - Pallet + type: string + PaymentType: + enum: + - Sender + - Recipient + - ThirdParty + type: string + PickupRequest: + type: object + properties: + courierId: + type: integer + format: int32 + locationId: + type: integer + format: int32 + lastPickupHour: + type: integer + format: int32 + lastPickMinute: + type: integer + format: int32 + additionalProperties: false + PickupResponse: + type: object + properties: + success: + type: boolean + message: + type: string + nullable: true + additionalProperties: false + PostalCodeInfo: + type: object + properties: + countryCode: + type: string + nullable: true + countryName: + type: string + nullable: true + postalCode: + type: string + nullable: true + streets: + type: array + items: + $ref: '#/components/schemas/PostalCodeInfoStreet' + nullable: true + additionalProperties: false + PostalCodeInfoStreet: + type: object + properties: + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countryId: + type: integer + format: int32 + countryName: + type: string + nullable: true + streetName: + type: string + nullable: true + group: + type: string + nullable: true + additionalProperties: false + PostalCodeStructured: + type: object + properties: + countryCode: + type: string + nullable: true + countryId: + type: integer + format: int32 + countryName: + type: string + nullable: true + countryNameLocalized: + type: string + nullable: true + counties: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredCounty' + nullable: true + additionalProperties: false + PostalCodeStructuredCounty: + type: object + properties: + countyId: + type: integer + format: int32 + countyName: + type: string + nullable: true + countyNameLocalized: + type: string + nullable: true + localities: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredLocality' + nullable: true + additionalProperties: false + PostalCodeStructuredLocality: + type: object + properties: + localityId: + type: integer + format: int32 + localityName: + type: string + nullable: true + localityNameLocalized: + type: string + nullable: true + streets: + type: array + items: + $ref: '#/components/schemas/PostalCodeStructuredStreet' + nullable: true + additionalProperties: false + PostalCodeStructuredStreet: + type: object + properties: + postalCode: + type: string + nullable: true + streetName: + type: string + nullable: true + streetNameLocalized: + type: string + nullable: true + neighbourhood: + type: string + nullable: true + neighbourhoodLocalized: + type: string + nullable: true + group: + type: string + nullable: true + streetPrefix: + type: string + nullable: true + streetPrefixLocalized: + type: string + nullable: true + additionalProperties: false + PriceRate: + type: object + properties: + carrierId: + type: integer + format: int32 + carrier: + type: string + nullable: true + rateAmount: + type: number + format: double + rateVatAmount: + type: number + format: double + rateTotalAmount: + type: number + format: double + readOnly: true + rateCurrency: + type: string + nullable: true + score: + type: number + format: double + performance: + type: number + format: double + calculatedDeliveryDate: + type: string + format: date-time + nullable: true + deliveryDays: + type: integer + format: int32 + serviceId: + type: integer + format: int32 + service: + type: string + nullable: true + priority: + type: integer + format: int32 + priceComponents: + type: object + properties: + Km: + type: number + format: double + KmFixed: + type: number + format: double + Envelopes: + type: number + format: double + ContentWeight: + type: number + format: double + Insurance: + type: number + format: double + CashOnDelivery: + type: number + format: double + BankRepayment: + type: number + format: double + FixedExtras: + type: number + format: double + Returns: + type: number + format: double + FuelSurcharge: + type: number + format: double + CourierPrice: + type: number + format: double + OpenPackage: + type: number + format: double + SaturdayDelivery: + type: number + format: double + PriceForExtraParcel: + type: number + format: double + ContentWeightZones: + type: number + format: double + ContentWeightPiecesZones: + type: number + format: double + PickupThirdParty: + type: number + format: double + InnoshipInsurance: + type: number + format: double + ReturnDocument: + type: number + format: double + ReturnPackage: + type: number + format: double + PalletType: + type: number + format: double + FuelSurchargeFlat: + type: number + format: double + ParcelsCount: + type: number + format: double + ExtraCharges: + type: number + format: double + HeaviestParcelWeight: + type: number + format: double + WeightAndLDM: + type: number + format: double + ZonePalletType: + type: number + format: double + CountryPalletType: + type: number + format: double + additionalProperties: false + nullable: true + additionalProperties: false + PriceResponse: + type: object + properties: + rates: + type: array + items: + $ref: '#/components/schemas/PriceRate' + nullable: true + correlationId: + type: string + nullable: true + additionalProperties: false + PurposeOfShipment: + enum: + - CommercialShipment + - NonCommercialShipment + type: string + RestrictionCountryCountyDto: + type: object + properties: + countryId: + type: integer + format: int32 + countyId: + type: integer + format: int32 + nullable: true + value: + type: integer + format: int32 + additionalProperties: false + SendSmsRequest: + type: object + properties: + campaignName: + type: string + nullable: true + data: + type: array + items: + $ref: '#/components/schemas/SendSmsRequestItem' + nullable: true + additionalProperties: false + SendSmsRequestItem: + type: object + properties: + phone: + type: array + items: + type: string + nullable: true + message: + type: string + nullable: true + additionalProperties: false + TrackRequest: + type: object + properties: + courier: + $ref: '#/components/schemas/Courier' + awbList: + type: array + items: + type: string + nullable: true + additionalProperties: false + TrackResponseHistory: + type: object + properties: + clientStatusId: + type: integer + format: int32 + clientStatusDescription: + type: string + nullable: true + eventDate: + type: string + format: date-time + isFinalStatus: + type: boolean + localityName: + type: string + nullable: true + additionalProperties: false + TrackResponseWithReturnInfo: + type: object + properties: + returnAwb: + type: string + nullable: true + returnAwbHistory: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + orderId: + type: integer + format: int32 + externalOrderId: + type: string + nullable: true + correlationId: + type: string + nullable: true + courier: + type: integer + format: int32 + shipmentAwb: + type: string + nullable: true + carrierMeasuredWeight: + type: number + format: double + nullable: true + recipientContactName: + type: string + nullable: true + recipientLocality: + type: string + nullable: true + recipientCountryCode: + type: string + nullable: true + trackUrl: + type: string + nullable: true + currentStatus: + type: string + nullable: true + currentStatusId: + type: integer + format: int32 + dispatchId: + type: string + nullable: true + history: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + cashOnDeliveryHistory: + type: array + items: + $ref: '#/components/schemas/TrackResponseHistory' + nullable: true + additionalProperties: false + UpdateLocationCourierServiceDto: + type: object + properties: + courierId: + type: integer + format: int32 + serviceId: + type: integer + format: int32 + courierServiceRestrictions: + $ref: '#/components/schemas/CourierServiceRestrictionsDto' + useCourierPrices: + type: boolean + nullable: true + mappingTemplateOptionId: + type: string + nullable: true + voucherTemplateOptionId: + type: string + nullable: true + extraServices: + type: object + additionalProperties: + type: boolean + nullable: true + nullable: true + mappingReferences: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + countryDeliveryDays: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + enabled: + type: boolean + nullable: true + localityKm: + type: integer + format: int32 + nullable: true + priceLocalityId: + type: integer + format: int32 + nullable: true + additionalProperties: false + UpdateLocationDto: + type: object + properties: + address: + $ref: '#/components/schemas/LocationAddressDto' + courierCutOffTimes: + type: string + nullable: true + courierAutomaticCallTimes: + type: string + nullable: true + useSameCourierForSameAddress: + type: boolean + courierFailPolicy: + type: integer + format: int32 + timeZoneId: + type: string + nullable: true + priceGroupId: + type: integer + format: int32 + nullable: true + notificationEmail: + type: string + nullable: true + notificationPhone: + type: string + nullable: true + courierVoucherService: + type: object + additionalProperties: + type: integer + format: int32 + nullable: true + nullable: true + marketPlaceCallBackSettings: + type: object + additionalProperties: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + importIsActive: + type: boolean + nullable: true + setHandoverOnManifest: + type: boolean + nullable: true + id: + type: integer + format: int32 + name: + type: string + nullable: true + externalLocationId: + type: string + nullable: true + additionalProperties: false + UpdateParcelsRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + envelopeCount: + type: integer + format: int32 + parcelsCount: + type: integer + format: int32 + palettesCount: + type: integer + format: int32 + oversizedPackage: + type: boolean + totalWeight: + type: number + format: double + parcels: + type: array + items: + $ref: '#/components/schemas/OrderRequestContentParcel' + nullable: true + parameters: + $ref: '#/components/schemas/OrderRequestParameters' + additionalProperties: false + UpdateStatusRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + typeId: + type: integer + format: int32 + nullable: true + statusId: + type: integer + format: int32 + actionDateTime: + type: string + format: date-time + additionalProperties: false + UploadDocumentsApiRequest: + type: object + properties: + courierId: + $ref: '#/components/schemas/Courier' + courierShipmentId: + type: string + nullable: true + attachments: + type: array + items: + $ref: '#/components/schemas/OrderRequestExtraCustomsDeclarationAttachment' + nullable: true + additionalProperties: false + UploadDocumentsApiResponse: + type: object + properties: + success: + type: boolean + message: + type: string + nullable: true + additionalProperties: false + securitySchemes: + ApiKeyAuth: + type: apiKey + name: X-Api-Key + in: header +security: + - ApiKeyAuth: + - readAccess + - writeAccess +servers: + - url: https://api.innoship.com diff --git a/sdks/db/processed-custom-request-cache/ilert.com.yaml b/sdks/db/processed-custom-request-cache/ilert.com.yaml new file mode 100644 index 0000000000..41440786d4 --- /dev/null +++ b/sdks/db/processed-custom-request-cache/ilert.com.yaml @@ -0,0 +1,67 @@ +processed: + securitySchemes: + apiKey: + type: apiKey + in: header + name: Authorization + description: >- + The Bearer API key of your user more info. + apiBaseUrl: /api + apiVersion: '' + apiDescription: >- + + The ilert API is a + [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API + and provides programmatic access to entities in ilert and lets you easily + integrate ilert with 3rd party tools. If you are looking to develop an + inbound integration (e.g. for a monitoring tool), please use our [Events + API](https://api.ilert.com). + + + The API supports the JSON content type for requests and responses. The + response content type is requested via the HTTP Accept header + (`application/json`). All resources are accessible via https and are located + at `api.ilert.com/api`. + + ## Authentication + + The REST API accepts bearer API tokens. Each user may create API keys using + the ilert web application. Note: Make sure to send the `Bearer ` prefix e.g. + `Bearer APIKEY` when sending api key requests. By default, access to all + resources (using any method) requires the client to be authenticated. + + + ## Team Context + When using API tokens, the currently selected team context of the user will not be taken into account, i.e. list results will always return all entities to which the user has a view permission. When using basic auth credentials the currently selected team context of the user will be used to filter resource results. The context may be overwritten for API key calls using the `team-context` HTTP header. Specifying `0` for ALL teams, `-1` for MY teams or a specific team id e.g. `team-context=901` to fetch results for a certain team. + + ## Errors + + ilert uses HTTP response codes to indicate success or failure of an API + request. Codes in the 2xx range indicate success, codes in the 4xx range + indicate a client error (e.g. a missing required parameter) and codes in the + 5xx range indicate an error with ilert's servers. In case of an error, the + response body contains the following information: + + Attribute | Description + ------------- | ------------- + status | the corresponsing HTTP status code + message | a human readable description of the error + code | error code, used to identify error type + + ## API Versioning + + Changes to our API are always backwards-compatible. To get more information + about our API versioning and historical changes, please take a look here. + apiTitle: ilert REST API + endpoints: 80 + sdkMethods: 162 + schemas: 164 + parameters: 713 + originalCustomRequest: + type: GET + url: https://api.ilert.com/api-docs/swagger.json + customRequestSpecFilename: ilert.com.yaml + difficultyScore: 422.25 diff --git a/sdks/db/processed-custom-request-cache/inmobile.com.yaml b/sdks/db/processed-custom-request-cache/inmobile.com.yaml new file mode 100644 index 0000000000..5e8443c71b --- /dev/null +++ b/sdks/db/processed-custom-request-cache/inmobile.com.yaml @@ -0,0 +1,29 @@ +processed: + securitySchemes: + BasicAuth: + type: http + description: >- + Provide Basic Authentiation with an arbitrary username and your api key + as password, e.g. some_value_to_be_ignored:your_api_key_here + scheme: basic + QueryParameter: + type: apiKey + description: >- + Specify your apikey in the url as + https://api.inmobile.com/some/path?apikey=your_api_key_here. This method + is only recommended if basic authorization is not possible. + name: apikey + in: query + apiBaseUrl: https://api.inmobile.com + apiVersion: version 4 + apiDescription: "\r\n# Introduction\r\n\r\nThis document is a technical description of our REST API used for external systems to send sms messages and to retrieve a status for each sms message sent and to maintain lists and blacklists.\r\n\r\nIn order to call our API, you need an api key. Log in to your account at https://mm.inmobile.dk, go to the \"API\" menu section and your api key will be available here.\r\n\r\nNOTE: It is required for clients to support tls 1.2 or higher.\r\n\r\n\r\n# Firewall openings\r\n\r\nThis is relevant for status callbacks and incoming SMS messages.\r\n\r\nYou can expect callbacks from one of the following IP ranges:\r\n\r\n* 46.36.205.80/28\r\n* 185.221.37.96/28\r\n\r\nThese are also the ip addresses which will be used for api.inmobile.com and mm.inmobile.dk - ensure access to these 2 ranges are opened in your firewall." + apiTitle: inMobile REST API + endpoints: 24 + sdkMethods: 36 + schemas: 66 + parameters: 71 + originalCustomRequest: + type: GET + url: https://api.inmobile.com/swagger/v1/swagger.json + customRequestSpecFilename: inmobile.com.yaml + difficultyScore: 86.75 diff --git a/sdks/db/processed-custom-request-cache/innoship.io.yaml b/sdks/db/processed-custom-request-cache/innoship.io.yaml new file mode 100644 index 0000000000..e566463a3f --- /dev/null +++ b/sdks/db/processed-custom-request-cache/innoship.io.yaml @@ -0,0 +1,21 @@ +processed: + securitySchemes: + ApiKeyAuth: + type: apiKey + name: X-Api-Key + in: header + apiBaseUrl: https://api.innoship.com + apiVersion: v1 + apiDescription: Api service implementation (version:6.0.1.503) + apiTitle: Innoship API + endpoints: 46 + sdkMethods: 51 + schemas: 75 + parameters: 330 + contactEmail: andrei@innoship.ro + originalCustomRequest: + type: GET + url: https://api.innoship.io/swagger/v1/swagger.json + apiBaseUrl: https://api.innoship.com + customRequestSpecFilename: innoship.io.yaml + difficultyScore: 171 diff --git a/sdks/db/progress/ilert-progress.yaml b/sdks/db/progress/ilert-progress.yaml new file mode 100644 index 0000000000..03cd14e076 --- /dev/null +++ b/sdks/db/progress/ilert-progress.yaml @@ -0,0 +1,494 @@ +examples: {} +examples_2: {} +examples_3: {} +ignoreObjectsWithNoProperties: true +operationIds: + /alert-actions: + get: AlertActions_getList + post: AlertActions_createNewAction + /alert-actions/{id}: + delete: AlertActions_removeSpecificAction + get: AlertActions_getSpecificAction + put: AlertActions_updateSpecificAlertAction + /alert-sources: + get: AlertSources_listSources + post: AlertSources_createNewSource + /alert-sources/{id}: + delete: AlertSources_deleteSpecifiedSource + get: AlertSources_getByIdOrApiKey + put: AlertSources_updateExistingSource + /alerts: + get: Alerts_listMatchingCriteria + post: Alerts_createCustomizedAlert + /alerts/count: + get: Alerts_getAlertCountMatchingCriteria + /alerts/{id}: + get: Alerts_getById + /alerts/{id}/accept: + put: Alerts_acceptAlert + /alerts/{id}/actions: + get: AlertActions_getAvailableActions + post: AlertActions_invokeSpecificAction + /alerts/{id}/assign: + put: Alerts_assignAlertTo + /alerts/{id}/log-entries: + get: Alerts_getLogEntries + /alerts/{id}/notifications: + get: Alerts_getNotifications + /alerts/{id}/resolve: + put: Alerts_resolveAlert + /alerts/{id}/responders: + post: Alerts_addResponder + /alerts/{id}/responders/{user-id}: + delete: Alerts_removeResponder + /alerts/{id}/suggested-responders: + get: Alerts_getAssignableResponders + /automation-rules: + get: AutomationRules_getDeprecatedRules + post: AutomationRules_createNewRule + /automation-rules/{id}: + delete: AutomationRules_removeSpecificRule + get: AutomationRules_getSpecificRule + put: AutomationRules_updateSpecificRule + /connectors: + get: Connectors_getAvailableConnectors + post: Connectors_createNewConnector + /connectors/{id}: + delete: Connectors_removeSpecificConnector + get: Connectors_getSpecificConnector + put: Connectors_updateSpecificConnector + /escalation-policies: + get: EscalationPolicies_listPolicies + post: EscalationPolicies_createNewPolicy + /escalation-policies/{id}: + delete: EscalationPolicies_deleteSpecificPolicy + get: EscalationPolicies_getById + put: EscalationPolicies_updateExistingPolicy + /events: + post: Events_postEventToIlert + /heartbeats/{key}: + get: Heartbeats_pingAlertSource + head: Heartbeats_pingAlertSource + post: Heartbeats_pingAlertSource + /incident-templates: + get: IncidentTemplates_getList + post: IncidentTemplates_createNewTemplate + /incident-templates/{id}: + delete: IncidentTemplates_removeSpecificTemplate + get: IncidentTemplates_getSpecificTemplate + put: IncidentTemplates_updateSpecificTemplate + /incidents: + get: Incidents_getIncidentList + post: Incidents_createNewIncident + /incidents/publish-info: + post: Incidents_forecastAffectedSubscribersAndStatusPages + /incidents/{id}: + get: Incidents_getSpecificIncident + put: Incidents_updateSpecificIncident + /incidents/{id}/private-subscribers: + get: Incidents_getPrivateSubscribers + post: Incidents_addSubscribers + /integrations: + get: Integrations_listAvailable + /maintenance-windows: + get: MaintenanceWindows_list + post: MaintenanceWindows_createNewWindow + /maintenance-windows/{id}: + delete: MaintenanceWindows_removeById + get: MaintenanceWindows_getById + put: MaintenanceWindows_updateExistingWindow + /metric-data-sources: + get: MetricDataSources_list + post: MetricDataSources_createNewMetricDataSource + /metric-data-sources/{id}: + delete: MetricDataSources_deleteSpecificDataSource + get: MetricDataSources_getSpecificDataSource + put: MetricDataSources_updateSpecificDataSource + /metric/{id}: + delete: Metrics_deleteSpecificMetric + get: Metrics_getSpecificMetric + put: Metrics_updateSpecificMetric + /metrics: + get: Metrics_getMetrics + post: Metrics_createNewMetric + /numbers: + get: Numbers_listAvailableNumbers + /on-calls: + get: OnCalls_listWithFilters + /reports/alerts: + get: Reports_listAlertMetrics + /reports/alerts/summary: + get: Reports_summarizeAlertMetrics + /reports/api-keys/usage: + get: Reports_listApiKeyUsageMetrics + /schedules: + get: Schedules_listOnCallSchedules + post: Schedules_createNewOnCallSchedule + /schedules/{id}: + delete: Schedules_deleteScheduleById + get: Schedules_getById + put: Schedules_updateOnCallSchedule + /schedules/{id}/overrides: + get: Schedules_getOverridesById + put: Schedules_addOverrideShift + /schedules/{id}/shifts: + get: Schedules_getShiftsByIdAndDateRange + /schedules/{id}/user-on-call: + get: Schedules_getUserOnCall + /series/{key}: + post: Series_ingestMetricSeries + /service-outages: + get: ServiceOutages_getServiceOutages + /service-outages/overrides: + get: ServiceOutages_getOverrides + post: ServiceOutages_overridePartHistory + /service-outages/overrides/{id}: + delete: ServiceOutages_removeOverride + get: ServiceOutages_getSpecificOverride + put: ServiceOutages_updateOverride + /services: + get: Services_listAvailableServices + post: Services_createService + /services/{id}: + delete: Services_removeSpecificService + get: Services_getSpecificService + put: Services_updateSpecificService + /services/{id}/private-subscribers: + get: Services_getSubscribers + put: Services_setPrivateSubscribers + /status-pages: + get: StatusPages_getStatusPages + post: StatusPages_createNewStatusPage + /status-pages/{id}: + delete: StatusPages_removeSpecificPage + get: StatusPages_getPageDetails + put: StatusPages_updateSpecificPage + /status-pages/{id}/groups: + get: StatusPages_getGroups + post: StatusPages_addGroupToPage + /status-pages/{id}/groups/{group-id}: + delete: StatusPages_removeGroup + get: StatusPages_getSpecificGroup + put: StatusPages_updateGroup + /status-pages/{id}/private-subscribers: + delete: StatusPages_removeSubscriber + get: StatusPages_getPrivateSubscribers + post: StatusPages_addSubscriber + put: StatusPages_setPrivateSubscribers + /support-hours: + get: SupportHours_list + post: SupportHours_createNewSupportHour + /support-hours/{id}: + delete: SupportHours_deleteSpecifiedSupportHour + get: SupportHours_getById + put: SupportHours_updateExistingHour + /teams: + get: Teams_getAll + post: Teams_createNewTeam + /teams/{id}: + delete: Teams_removeSpecificTeam + get: Teams_getDetails + put: Teams_updateSpecificTeam + /teams/{id}/members: + post: Teams_addNewMember + /teams/{id}/members/{id}: + delete: Teams_removeSpecificMember + /users: + get: Users_listExistingUsers + post: Users_createNewUser + /users/current: + get: Users_getCurrentUser + put: Users_updateCurrentUser + /users/{user-id}: + delete: Users_deleteUser + get: Users_getUserById + put: Users_updateExistingUser + /users/{user-id}/contacts/emails: + get: Contacts_getUserEmails + post: Contacts_addNewEmail + /users/{user-id}/contacts/emails/{id}: + delete: Contacts_deleteUserEmail + get: Contacts_getEmail + put: Contacts_updateUserEmail + /users/{user-id}/contacts/phone-numbers: + get: Contacts_getUserPhoneNumbers + post: Contacts_createPhoneNumber + /users/{user-id}/contacts/phone-numbers/{id}: + delete: Contacts_deletePhoneNumber + get: Contacts_getPhoneNumber + put: Contacts_updateUserPhoneNumber + /users/{user-id}/notification-preferences/alerts: + get: NotificationPreferences_getUserAlerts + post: NotificationPreferences_createAlertPreference + /users/{user-id}/notification-preferences/alerts/{id}: + delete: NotificationPreferences_deleteUserNotificationPreferencesAlert + get: NotificationPreferences_getSpecificAlert + put: NotificationPreferences_updateAlertPreference + /users/{user-id}/notification-preferences/duties: + get: NotificationPreferences_getUserDutyPreferences + post: NotificationPreferences_createDuty + /users/{user-id}/notification-preferences/duties/{id}: + delete: NotificationPreferences_deleteUserNotificationDuty + get: NotificationPreferences_getSpecificDuty + put: NotificationPreferences_updateDutyNotificationPreference + /users/{user-id}/notification-preferences/subscriptions: + get: NotificationPreferences_getUserSubscriptions + post: NotificationPreferences_createSubscriptionNotificationPreference + /users/{user-id}/notification-preferences/subscriptions/{id}: + delete: NotificationPreferences_deleteSubscription + get: NotificationPreferences_getSpecificSubscription + put: NotificationPreferences_updateSubscriptionPreference + /users/{user-id}/notification-preferences/updates: + get: NotificationPreferences_getUserUpdatePreferences + post: NotificationPreferences_createUpdatePreference + /users/{user-id}/notification-preferences/updates/{id}: + delete: NotificationPreferences_deleteUpdate + get: NotificationPreferences_getSpecificUpdate + put: NotificationPreferences_updateUserUpdateNotificationPreference +operationTags: {} +renameTags: {} +requestSchemaNames: + /incidents/{id}/private-subscribers: + post: + application/json: IncidentsAddSubscribersRequest + /services/{id}/private-subscribers: + put: + application/json: ServicesSetPrivateSubscribersRequest +responseDescriptions: {} +responseSchemaNames: + /alert-actions: + get: + '200': + application/json: AlertActionsGetListResponse + /alert-sources: + get: + '200': + application/json: AlertSourcesListSourcesResponse + /alerts: + get: + '200': + application/json: AlertsListMatchingCriteriaResponse + /alerts/{id}/log-entries: + get: + '200': + application/json: AlertsGetLogEntriesResponse + /alerts/{id}/notifications: + get: + '200': + application/json: AlertsGetNotificationsResponse + /alerts/{id}/suggested-responders: + get: + '200': + application/json: AlertsGetAssignableRespondersResponse + /automation-rules: + get: + '200': + application/json: AutomationRulesGetDeprecatedRulesResponse + /connectors: + get: + '200': + application/json: ConnectorsGetAvailableConnectorsResponse + /escalation-policies: + get: + '200': + application/json: EscalationPoliciesListPoliciesResponse + /incident-templates: + get: + '200': + application/json: IncidentTemplatesGetListResponse + /incidents: + get: + '200': + application/json: IncidentsGetIncidentListResponse + /incidents/publish-info: + post: + '200': + application/json: IncidentsForecastAffectedSubscribersAndStatusPagesResponse + /incidents/{id}/private-subscribers: + get: + '200': + application/json: IncidentsGetPrivateSubscribersResponse + /integrations: + get: + '200': + application/json: IntegrationsListAvailableResponse + /maintenance-windows: + get: + '200': + application/json: MaintenanceWindowsListResponse + /metric-data-sources: + get: + '200': + application/json: MetricDataSourcesListResponse + /metrics: + get: + '200': + application/json: MetricsGetMetricsResponse + /numbers: + get: + '200': + application/json: NumbersListAvailableNumbersResponse + /on-calls: + get: + '200': + application/json: OnCallsListWithFiltersResponse + /reports/alerts: + get: + '200': + application/json: ReportsListAlertMetricsResponse + /reports/alerts/summary: + get: + '200': + application/json: ReportsSummarizeAlertMetricsResponse + /reports/api-keys/usage: + get: + '200': + application/json: ReportsListApiKeyUsageMetricsResponse + /schedules: + get: + '200': + application/json: SchedulesListOnCallSchedulesResponse + /schedules/{id}/overrides: + get: + '200': + application/json: SchedulesGetOverridesByIdResponse + /schedules/{id}/shifts: + get: + '200': + application/json: SchedulesGetShiftsByIdAndDateRangeResponse + /service-outages: + get: + '200': + application/json: ServiceOutagesGetServiceOutagesResponse + /service-outages/overrides: + get: + '200': + application/json: ServiceOutagesGetOverridesResponse + /services: + get: + '200': + application/json: ServicesListAvailableServicesResponse + /services/{id}/private-subscribers: + get: + '200': + application/json: ServicesGetSubscribersResponse + /status-pages: + get: + '200': + application/json: StatusPagesGetStatusPagesResponse + /status-pages/{id}/groups: + get: + '200': + application/json: StatusPagesGetGroupsResponse + /status-pages/{id}/private-subscribers: + get: + '200': + application/json: StatusPagesGetPrivateSubscribersResponse + /support-hours: + get: + '200': + application/json: SupportHoursListResponse + /teams: + get: + '200': + application/json: TeamsGetAllResponse + /users: + get: + '200': + application/json: UsersListExistingUsersResponse + /users/{user-id}/contacts/emails: + get: + '200': + application/json: ContactsGetUserEmailsResponse + /users/{user-id}/contacts/phone-numbers: + get: + '200': + application/json: ContactsGetUserPhoneNumbersResponse + /users/{user-id}/notification-preferences/alerts: + get: + '200': + application/json: NotificationPreferencesGetUserAlertsResponse + /users/{user-id}/notification-preferences/duties: + get: + '200': + application/json: NotificationPreferencesGetUserDutyPreferencesResponse + /users/{user-id}/notification-preferences/subscriptions: + get: + '200': + application/json: NotificationPreferencesGetUserSubscriptionsResponse + /users/{user-id}/notification-preferences/updates: + get: + '200': + application/json: NotificationPreferencesGetUserUpdatePreferencesResponse +securityParameters: + If-Match: + header: false + abort-on-gaps: + query: false + connector: + query: false + exclude-overrides: + query: false + expand: + query: false + filter-types: + query: false + from: + query: false + group-by: + query: false + ignore-overrides: + query: false + include: + query: false + lang: + query: false + max-results: + query: false + members: + query: false + metric: + query: false + numbers: + query: false + policies: + query: false + policy: + query: false + policy-levels: + query: false + priority: + query: false + responders: + query: false + schedule: + query: false + schedules: + query: false + scopes: + query: false + service: + query: false + services: + query: false + source: + query: false + sources: + query: false + start-index: + query: false + states: + query: false + status-page: + query: false + timezone: + query: false + until: + query: false + user: + query: false + users: + query: false +validServerUrls: + /api: + url: /api diff --git a/sdks/db/progress/in-mobile-progress.yaml b/sdks/db/progress/in-mobile-progress.yaml new file mode 100644 index 0000000000..390f4112d4 --- /dev/null +++ b/sdks/db/progress/in-mobile-progress.yaml @@ -0,0 +1,46 @@ +examples: {} +examples_2: {} +examples_3: {} +ignorePotentialIncorrectType: true +operationIds: {} +operationTags: {} +renameTags: {} +requestSchemaNames: {} +responseDescriptions: {} +responseSchemaNames: {} +securityParameters: + CountryHint: + query: false + Encoding: + query: false + Flash: + query: false + From: + query: false + MessageId: + query: false + MsisdnCooldownInMinutes: + query: false + RespectBlacklist: + query: false + SendTime.LocalServerTime: + query: false + SendTime.UtcTime: + query: false + StatusCallbackUrl: + query: false + Text: + query: false + To: + query: false + ValidityPeriodInSeconds: + query: false + countryCode: + query: false + limit: + query: false + pageLimit: + query: false + phoneNumber: + query: false +validServerUrls: {} diff --git a/sdks/db/progress/innoship-progress.yaml b/sdks/db/progress/innoship-progress.yaml new file mode 100644 index 0000000000..25e5e8cbe3 --- /dev/null +++ b/sdks/db/progress/innoship-progress.yaml @@ -0,0 +1,244 @@ +examples: {} +examples_2: {} +examples_3: {} +operationIds: + /api/ClientLocation: + get: ClientLocation_getDetail + post: ClientLocation_createNew + /api/ClientLocation/Summary: + post: ClientLocation_createSummaryReport + /api/ClientLocation/Validate: + post: ClientLocation_validateLocationDetails + /api/ClientLocation/{id}: + delete: ClientLocation_removeById + get: ClientLocation_getById + put: ClientLocation_updateById + /api/ClientLocation/{locationId}/Courier: + post: ClientLocation_createCourier + /api/ClientLocation/{locationId}/Courier/{courierId}: + delete: ClientLocation_removeCourierById + /api/ClientLocation/{locationId}/CourierServices: + patch: ClientLocation_updateCourierServices + put: ClientLocation_updateCourierServices + /api/Courier/All: + get: Courier_getAll + /api/Courier/RequestPickup: + post: Courier_requestPickup + /api/Feedback/{from}/{to}: + get: Feedback_getBetweenDates + /api/Label/bulk: + post: Label_createBulk + /api/Label/bulk/{operationId}: + get: Label_getBulkByOperationId + /api/Label/by-courier/{courierId}/awb/{awb}: + get: Label_getByCourierAwb + /api/Label/by-courier/{courierId}/awb/{awb}/parcel/{barcodes}: + get: Label_getByAwbAndParcel + /api/Label/by-courier/{courierId}/voucher/{awb}: + get: Label_getVoucherByCourierAwb + /api/Location/ClientLocations: + get: Location_getClientLocations + /api/Location/Counties/{countryCode}: + get: Location_getCountiesByCountryCode + /api/Location/Countries: + get: Location_getCountryList + /api/Location/FixedLocation/{id}: + get: Location_getFixedLocationById + /api/Location/FixedLocations: + get: Location_getFixedLocations + /api/Location/Localities/{countyId}: + get: Location_getLocalitiesByCountyId + /api/Location/Postalcodes/Country/{CountryCode}: + get: Location_getPostalCodesByCountry + /api/Location/Postalcodes/{CountryCode}/{PostalCode}: + get: Location_getPostalCodeDetails + /api/Location/Postalcodes/{LocalityId}: + get: Location_getPostalcodesByLocalityId + /api/Manifest: + get: Manifest_reportById + post: Manifest_requestPickupAndManifestId + /api/Notifications/sendsms: + post: Notifications_sendSmsNotification + /api/OfflineOrder/Activate: + put: OfflineOrder_activateOrder + /api/OfflineOrder/Add: + post: OfflineOrder_addOrder + /api/OfflineOrder/Edit: + put: OfflineOrder_updateOrderDetails + /api/Order: + post: Order_createNewOrder + /api/Order/ReturnAwbInfo/{courierId}/{returnAwb}: + get: Order_getReturnAwbInfo + /api/Order/UpdateCustomAttributes/{courierId}/awb/{awb}: + post: Order_updateCustomAttributes + /api/Order/UpdateParcels: + post: Order_updateParcels + /api/Order/UpdateStatus: + post: Order_updateStatus + /api/Order/UploadDocuments: + post: Order_uploadDocuments + /api/Order/by-location/{externalLocationId}/{from}/{to}: + get: Order_getByLocationDates + /api/Order/file: + post: Order_uploadFile + /api/Order/multiple/simulate: + post: Order_simulateMultiple + /api/Order/simulate: + post: Order_simulateOrder + /api/Order/validate: + post: Order_validateNewOrder + /api/Order/{courierId}/awb/{awbNo}: + delete: Order_deleteExistingOrder + /api/Price: + post: Price_getPrices + /api/Track/by-awb/with-return: + post: Track_orderCourierAwbWithReturn + /api/Track/return/by-awb: + post: Track_byAwb + /api/Voucher/Activate: + post: Voucher_activateVoucher + /api/Voucher/Create: + post: Voucher_generateNewVoucher +operationTags: {} +renameTags: {} +requestSchemaNames: + /api/ClientLocation/{locationId}/CourierServices: + patch: + application/*+json: ClientLocationUpdateCourierServicesRequest3 + application/json: ClientLocationUpdateCourierServicesRequest1 + application/json-patch+json: ClientLocationUpdateCourierServicesRequest + text/json: ClientLocationUpdateCourierServicesRequest2 + put: + application/*+json: ClientLocationUpdateCourierServicesRequest7 + application/json: ClientLocationUpdateCourierServicesRequest5 + application/json-patch+json: ClientLocationUpdateCourierServicesRequest4 + text/json: ClientLocationUpdateCourierServicesRequest6 + /api/OfflineOrder/Activate: + put: + application/*+json: OfflineOrderActivateOrderRequest3 + application/json: OfflineOrderActivateOrderRequest1 + application/json-patch+json: OfflineOrderActivateOrderRequest + text/json: OfflineOrderActivateOrderRequest2 + /api/OfflineOrder/Add: + post: + application/*+json: OfflineOrderAddOrderRequest3 + application/json: OfflineOrderAddOrderRequest1 + application/json-patch+json: OfflineOrderAddOrderRequest + text/json: OfflineOrderAddOrderRequest2 + /api/OfflineOrder/Edit: + put: + application/*+json: OfflineOrderUpdateOrderDetailsRequest3 + application/json: OfflineOrderUpdateOrderDetailsRequest1 + application/json-patch+json: OfflineOrderUpdateOrderDetailsRequest + text/json: OfflineOrderUpdateOrderDetailsRequest2 + /api/Order/UpdateCustomAttributes/{courierId}/awb/{awb}: + post: + application/*+json: OrderUpdateCustomAttributesRequest3 + application/json: OrderUpdateCustomAttributesRequest1 + application/json-patch+json: OrderUpdateCustomAttributesRequest + text/json: OrderUpdateCustomAttributesRequest2 + /api/Order/UpdateStatus: + post: + application/*+json: OrderUpdateStatusRequest3 + application/json: OrderUpdateStatusRequest1 + application/json-patch+json: OrderUpdateStatusRequest + text/json: OrderUpdateStatusRequest2 + /api/Order/multiple/simulate: + post: + application/*+json: OrderSimulateMultipleRequest3 + application/json: OrderSimulateMultipleRequest1 + application/json-patch+json: OrderSimulateMultipleRequest + text/json: OrderSimulateMultipleRequest2 +responseDescriptions: {} +responseSchemaNames: + /api/Courier/All: + get: + '200': + application/json: CourierGetAllResponse + /api/Location/Postalcodes/{LocalityId}: + get: + '200': + application/json: LocationGetPostalcodesByLocalityId200Response + text/json: LocationGetPostalcodesByLocalityId200Response + text/plain: LocationGetPostalcodesByLocalityIdResponse + /api/Order/file: + post: + '201': + application/json: OrderUploadFileResponse + /api/Order/multiple/simulate: + post: + '201': + application/json: OrderSimulateMultipleResponse + '400': + application/json: OrderSimulateMultiple400Response + '401': + application/json: OrderSimulateMultiple401Response + /api/Track/by-awb/with-return: + post: + '200': + application/json: TrackOrderCourierAwbWithReturn200Response + text/json: TrackOrderCourierAwbWithReturn200Response + text/plain: TrackOrderCourierAwbWithReturnResponse + /api/Track/return/by-awb: + post: + '200': + application/json: TrackByAwb200Response + text/json: TrackByAwb200Response + text/plain: TrackByAwbResponse +securityParameters: + CountryCode: + query: false + CountyName: + query: false + Courier: + query: false + CourierId: + query: false + ExternalLocationId: + query: false + FixedLocationType: + query: false + Latitude: + query: false + LocalityName: + query: false + Longitude: + query: false + Radius: + query: false + RestrictionParcelsCount: + query: false + RestrictionSizeHeight: + query: false + RestrictionSizeLength: + query: false + RestrictionSizeWidth: + query: false + ShowInactive: + query: false + api-version: + header: false + query: false + applyToAllLocations: + query: false + countryCode: + query: false + filter: + query: false + force: + query: false + format: + query: false + includeVoucher: + query: false + isEmagMarketPlace: + query: false + manifestId: + query: false + skipCache: + query: false + type: + query: false + useFile: + query: false +validServerUrls: {} diff --git a/sdks/db/published/from-custom-request_fordefi.com.json b/sdks/db/published/from-custom-request_fordefi.com.json index 756bf4f807..832c6e9ee3 100644 --- a/sdks/db/published/from-custom-request_fordefi.com.json +++ b/sdks/db/published/from-custom-request_fordefi.com.json @@ -23,7 +23,7 @@ "company": "FORDEFI", "sdkName": "fordefi-{language}-sdk", "clientName": "Fordefi", - "metaDescription": "The future of institutional web3 wallets. \n\nFor builders, traders, and operators, Fordefi's comprehensive MPC wallet platform and web3 gateway enables you to securely self-custody your private keys, seamlessly connect to thousands of dApps across any blockchain, protect your workflows with granular policies, and manage your digital asset operations all-in-one place.", + "metaDescription": "The future of institutional web3 wallets.\n\nFor builders, traders, and operators, Fordefi's comprehensive MPC wallet platform and web3 gateway enables you to securely self-custody your private keys, seamlessly connect to thousands of dApps across any blockchain, protect your workflows with granular policies, and manage your digital asset operations all-in-one place.", "apiStatusUrls": "inherit", "homepage": "fordefi.com", "developerDocumentation": "docs.fordefi.com/reference/api-overview", @@ -33,7 +33,7 @@ "mpc_wallet" ], "category": "Finance", - "apiDescription": "The future of institutional web3 wallets. \n\nFor builders, traders, and operators, Fordefi's comprehensive MPC wallet platform and web3 gateway enables you to securely self-custody your private keys, seamlessly connect to thousands of dApps across any blockchain, protect your workflows with granular policies, and manage your digital asset operations all-in-one place.", + "apiDescription": "The future of institutional web3 wallets.\n\nFor builders, traders, and operators, Fordefi's comprehensive MPC wallet platform and web3 gateway enables you to securely self-custody your private keys, seamlessly connect to thousands of dApps across any blockchain, protect your workflows with granular policies, and manage your digital asset operations all-in-one place.", "methods": [ { "url": "/api/v1/blockchains", @@ -3040,14 +3040,14 @@ ] } ], - "repositoryDescription": "Institutional web3 wallets for builders, traders, and operators. Securely self-custody private keys, connect to dApps, protect workflows with policies, manage digital assets in one place. FORDEFI's {language} SDK generated by Konfig (https://konfigthis.com/).", + "repositoryDescription": "Fordefi: The ultimate MPC wallet for web3, enabling secure key custody, dApp connectivity, policy protection, and asset management in one platform. FORDEFI's {language} SDK generated by Konfig (https://konfigthis.com/).", "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/fordefi/logo.png", "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/fordefi/openapi.yaml", "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/fordefi/openapi.yaml", "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/fordefi/imagePreview.jpg", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/fordefi/favicon.png", "clientNameCamelCase": "fordefi", - "lastUpdated": "2024-03-29T21:57:13.775Z", + "lastUpdated": "2024-03-29T22:11:39.095Z", "typescriptSdkUsageCode": "import { Fordefi } from 'fordefi-typescript-sdk';\n\nconst fordefi = new Fordefi({\n bearerAuth: \"BEARER_AUTH\"\n})", "typescriptSdkFirstRequestCode": "// List Chains\nconst getListResponse = fordefi.blockchains.getList()", "fixedSpecFileName": "fordefi-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_griffin.com.json b/sdks/db/published/from-custom-request_griffin.com.json index 0c9b08af02..d3609e89e5 100644 --- a/sdks/db/published/from-custom-request_griffin.com.json +++ b/sdks/db/published/from-custom-request_griffin.com.json @@ -21,7 +21,7 @@ }, "customRequestSpecFilename": "griffin.com.yaml", "difficultyScore": 118.75, - "difficulty": "Medium", + "difficulty": "Easy", "company": "Griffin", "sdkName": "griffin-{language}-sdk", "clientName": "Griffin", @@ -3250,7 +3250,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/griffin/imagePreview.jpg", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/griffin/favicon.png", "clientNameCamelCase": "griffin", - "lastUpdated": "2024-03-25T20:47:15.965Z", + "lastUpdated": "2024-03-29T22:11:39.095Z", "typescriptSdkUsageCode": "import { Griffin } from 'griffin-typescript-sdk';\n\nconst griffin = new Griffin({\n /*\n * API token authentication.\n * It should follow the format: `GriffinAPIKey g-test-MyKey-XXXXXXX`\n */\n apiKeyAuth: \"AUTHORIZATION\"\n})", "typescriptSdkFirstRequestCode": "// Index\nconst globalPathsFetchResponse = griffin.navigation.globalPathsFetch()", "fixedSpecFileName": "griffin-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_ilert.com.json b/sdks/db/published/from-custom-request_ilert.com.json new file mode 100644 index 0000000000..38fda00b80 --- /dev/null +++ b/sdks/db/published/from-custom-request_ilert.com.json @@ -0,0 +1,6921 @@ +{ + "securitySchemes": { + "apiKey": { + "type": "apiKey", + "in": "header", + "name": "Authorization", + "description": "The Bearer API key of your user more info." + } + }, + "apiBaseUrl": "/api", + "apiVersion": "", + "apiDescription": "\nThe ilert API is a [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API and provides programmatic access to entities in ilert and lets you easily integrate ilert with 3rd party tools. If you are looking to develop an inbound integration (e.g. for a monitoring tool), please use our [Events API](https://api.ilert.com). \n\nThe API supports the JSON content type for requests and responses. The response content type is requested via the HTTP Accept header (`application/json`). All resources are accessible via https and are located at `api.ilert.com/api`. \n## Authentication\nThe REST API accepts bearer API tokens. Each user may create API keys using the ilert web application. Note: Make sure to send the `Bearer ` prefix e.g. `Bearer APIKEY` when sending api key requests. By default, access to all resources (using any method) requires the client to be authenticated.\n\n## Team Context\n When using API tokens, the currently selected team context of the user will not be taken into account, i.e. list results will always return all entities to which the user has a view permission. When using basic auth credentials the currently selected team context of the user will be used to filter resource results. The context may be overwritten for API key calls using the `team-context` HTTP header. Specifying `0` for ALL teams, `-1` for MY teams or a specific team id e.g. `team-context=901` to fetch results for a certain team. \n\n## Errors\nilert uses HTTP response codes to indicate success or failure of an API request. Codes in the 2xx range indicate success, codes in the 4xx range indicate a client error (e.g. a missing required parameter) and codes in the 5xx range indicate an error with ilert's servers. In case of an error, the response body contains the following information:\n\n Attribute | Description \n ------------- | ------------- \n status | the corresponsing HTTP status code \n message | a human readable description of the error \n code | error code, used to identify error type \n\n## API Versioning\nChanges to our API are always backwards-compatible. To get more information about our API versioning and historical changes, please take a look here.", + "apiTitle": "ilert REST API", + "endpoints": 80, + "sdkMethods": 162, + "schemas": 207, + "parameters": 713, + "originalCustomRequest": { + "type": "GET", + "url": "https://api.ilert.com/api-docs/swagger.json" + }, + "customRequestSpecFilename": "ilert.com.yaml", + "difficultyScore": 422.25, + "difficulty": "Hard", + "company": "ilert", + "sdkName": "ilert-{language}-sdk", + "clientName": "Ilert", + "metaDescription": "ilert is a SaaS company for alerting, on-call management and incident communication and helps companies to increase their digital uptime. B2C and B2B companies from across the globe, including well-known brands such as Bertelsmann, TeamViewer and REWE, trust ilert to empower their operations teams and ensure everything is running smoothly.", + "apiStatusUrls": "inherit", + "homepage": "ilert.com", + "developerDocumentation": "api.ilert.com/api-docs", + "categories": [ + "alerting", + "on_call_management", + "incident_communication" + ], + "category": "Compliance & Security", + "methods": [ + { + "url": "/users/{user-id}", + "method": "deleteUser", + "httpMethod": "delete", + "tag": "Users", + "typeScriptTag": "users", + "description": "Delete the specified user.", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/users/{user-id}", + "method": "getUserById", + "httpMethod": "get", + "tag": "Users", + "typeScriptTag": "users", + "description": "Get the specified user.", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}", + "method": "updateExistingUser", + "httpMethod": "put", + "tag": "Users", + "typeScriptTag": "users", + "description": "Update an existing user.", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "integer", + "required": false, + "description": "" + }, + { + "name": "firstName", + "schema": "string", + "required": true, + "description": "", + "example": "FIRSTNAME" + }, + { + "name": "lastName", + "schema": "string", + "required": true, + "description": "", + "example": "LASTNAME" + }, + { + "name": "email", + "schema": "string", + "required": true, + "description": "", + "example": "EMAIL" + }, + { + "name": "timezone", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "position", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "department", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "avatarUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "language", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "role", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "shiftColor", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "mutedUntil", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "createdAt", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/contacts/emails", + "method": "getUserEmails", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Get a user's emails", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/contacts/emails", + "method": "addNewEmail", + "httpMethod": "post", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Create a new email", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "target", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/contacts/emails/{id}", + "method": "deleteUserEmail", + "httpMethod": "delete", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Delete the user's specified email", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/users/{user-id}/contacts/emails/{id}", + "method": "getEmail", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Get a specific email", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/contacts/emails/{id}", + "method": "updateUserEmail", + "httpMethod": "put", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Update a user's email", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "target", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/contacts/phone-numbers", + "method": "getUserPhoneNumbers", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Get a user's phone numbers", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/contacts/phone-numbers", + "method": "createPhoneNumber", + "httpMethod": "post", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Create a phone number", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "regionCode", + "schema": "string", + "description": "" + }, + { + "name": "target", + "schema": "string", + "description": "" + }, + { + "name": "primary", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/contacts/phone-numbers/{id}", + "method": "deletePhoneNumber", + "httpMethod": "delete", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Delete the user's specified phone number", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/users/{user-id}/contacts/phone-numbers/{id}", + "method": "getPhoneNumber", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Get specific phone number", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/contacts/phone-numbers/{id}", + "method": "updateUserPhoneNumber", + "httpMethod": "put", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Update a user's phone number", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "regionCode", + "schema": "string", + "description": "" + }, + { + "name": "target", + "schema": "string", + "description": "" + }, + { + "name": "primary", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/alerts", + "method": "getUserAlerts", + "httpMethod": "get", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Get alert notification preferences of a user", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/alerts", + "method": "createAlertPreference", + "httpMethod": "post", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Create an alert notification preference", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "method", + "schema": "string", + "description": "" + }, + { + "name": "contact", + "schema": "undefined", + "description": "" + }, + { + "name": "delayMin", + "schema": "integer", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/alerts/{id}", + "method": "deleteUserNotificationPreferencesAlert", + "httpMethod": "delete", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Delete the user's specified notification preferences alert", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/alerts/{id}", + "method": "getSpecificAlert", + "httpMethod": "get", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Get specific notification preferences alert", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/alerts/{id}", + "method": "updateAlertPreference", + "httpMethod": "put", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Update a user's alert notification preference", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "method", + "schema": "string", + "description": "" + }, + { + "name": "contact", + "schema": "undefined", + "description": "" + }, + { + "name": "delayMin", + "schema": "integer", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/duties", + "method": "getUserDutyPreferences", + "httpMethod": "get", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Get duty notification preferences of a user", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/duties", + "method": "createDuty", + "httpMethod": "post", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Create a duty notification preference", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "beforeMin", + "schema": "integer", + "description": "" + }, + { + "name": "contact", + "schema": "undefined", + "description": "" + }, + { + "name": "method", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/duties/{id}", + "method": "deleteUserNotificationDuty", + "httpMethod": "delete", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Delete the user's specified notification preferences duty", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/duties/{id}", + "method": "getSpecificDuty", + "httpMethod": "get", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Get specific notification preferences duty", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/duties/{id}", + "method": "updateDutyNotificationPreference", + "httpMethod": "put", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Update a user's duty notification preference", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "beforeMin", + "schema": "integer", + "description": "" + }, + { + "name": "contact", + "schema": "undefined", + "description": "" + }, + { + "name": "method", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/updates", + "method": "getUserUpdatePreferences", + "httpMethod": "get", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Get update notification preferences of a user", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/updates", + "method": "createUpdatePreference", + "httpMethod": "post", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Create an update notification preference", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "contact", + "schema": "undefined", + "description": "" + }, + { + "name": "method", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/updates/{id}", + "method": "deleteUpdate", + "httpMethod": "delete", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Delete the user's specified notification preferences update", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/updates/{id}", + "method": "getSpecificUpdate", + "httpMethod": "get", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Get specific notification preferences update", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/updates/{id}", + "method": "updateUserUpdateNotificationPreference", + "httpMethod": "put", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Update a user's update notification preference", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "contact", + "schema": "undefined", + "description": "" + }, + { + "name": "method", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/subscriptions", + "method": "getUserSubscriptions", + "httpMethod": "get", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Get subscription notification preferences of a user", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/subscriptions", + "method": "createSubscriptionNotificationPreference", + "httpMethod": "post", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Create a subscription notification preference", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "contact", + "schema": "undefined", + "description": "" + }, + { + "name": "method", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/subscriptions/{id}", + "method": "deleteSubscription", + "httpMethod": "delete", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Delete the user's specified notification preferences subscription", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/subscriptions/{id}", + "method": "getSpecificSubscription", + "httpMethod": "get", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Get specific notification preferences subscription", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/{user-id}/notification-preferences/subscriptions/{id}", + "method": "updateSubscriptionPreference", + "httpMethod": "put", + "tag": "Notification Preferences", + "typeScriptTag": "notificationPreferences", + "description": "Update a user's subscription notification preference", + "parameters": [ + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + }, + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "contact", + "schema": "undefined", + "description": "" + }, + { + "name": "method", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/numbers", + "method": "listAvailableNumbers", + "httpMethod": "get", + "tag": "Numbers", + "typeScriptTag": "numbers", + "description": "List available phone numbers that ilert uses to send voice and SMS notifications", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/integrations", + "method": "listAvailable", + "httpMethod": "get", + "tag": "Integrations", + "typeScriptTag": "integrations", + "description": "List available inbound and outbound integrations. Note: this resource is paginated.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users", + "method": "listExistingUsers", + "httpMethod": "get", + "tag": "Users", + "typeScriptTag": "users", + "description": "List existing users.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users", + "method": "createNewUser", + "httpMethod": "post", + "tag": "Users", + "typeScriptTag": "users", + "description": "Create a new user. Requires ADMIN privileges.", + "parameters": [ + { + "name": "firstName", + "schema": "string", + "required": true, + "description": "", + "example": "FIRSTNAME" + }, + { + "name": "lastName", + "schema": "string", + "required": true, + "description": "", + "example": "LASTNAME" + }, + { + "name": "email", + "schema": "string", + "required": true, + "description": "", + "example": "EMAIL" + }, + { + "name": "timezone", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "position", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "department", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "avatarUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "language", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "role", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "shiftColor", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/users/current", + "method": "getCurrentUser", + "httpMethod": "get", + "tag": "Users", + "typeScriptTag": "users", + "description": "Get the currently authenticated user.", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/users/current", + "method": "updateCurrentUser", + "httpMethod": "put", + "tag": "Users", + "typeScriptTag": "users", + "description": "Update the current user.", + "parameters": [ + { + "name": "firstName", + "schema": "string", + "required": true, + "description": "", + "example": "FIRSTNAME" + }, + { + "name": "lastName", + "schema": "string", + "required": true, + "description": "", + "example": "LASTNAME" + }, + { + "name": "email", + "schema": "string", + "required": true, + "description": "", + "example": "EMAIL" + }, + { + "name": "timezone", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "position", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "department", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "avatarUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "language", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "role", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "shiftColor", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts", + "method": "listMatchingCriteria", + "httpMethod": "get", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "List alerts (optionally matching certain criteria that are specified by query parameters).", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (https://api.ilert.com/api-docs" + }, + { + "name": "states", + "schema": "array", + "description": "state of the alert" + }, + { + "name": "sources", + "schema": "array", + "description": "alert source IDs of the alert's alert source" + }, + { + "name": "policies", + "schema": "array", + "description": "escalation policy IDs of the alert's escalation policy" + }, + { + "name": "responders", + "schema": "array", + "description": "user ids of the user that is a responder of the alert" + }, + { + "name": "from", + "schema": "string", + "description": "from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z, based on reportTime" + }, + { + "name": "until", + "schema": "string", + "description": "until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z, based on reportTime" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts", + "method": "createCustomizedAlert", + "httpMethod": "post", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Create alerts with customised parameters without requiring events from monitoring tools that use our Events API.", + "parameters": [ + { + "name": "summary", + "schema": "string", + "required": true, + "description": "", + "example": "SUMMARY" + }, + { + "name": "details", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertSource", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "escalationPolicy", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "priority", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "assignedTo", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "images", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "links", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "responders", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/alerts/count", + "method": "getAlertCountMatchingCriteria", + "httpMethod": "get", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Get the alert count matching the specified criteria.", + "parameters": [ + { + "name": "states", + "schema": "array", + "description": "state of the alert" + }, + { + "name": "sources", + "schema": "array", + "description": "alert source IDs of the alert's alert source" + }, + { + "name": "responders", + "schema": "array", + "description": "user ids of the user that is a responder of the alert" + }, + { + "name": "from", + "schema": "string", + "description": "from date" + }, + { + "name": "until", + "schema": "string", + "description": "until date" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts/{id}", + "method": "getById", + "httpMethod": "get", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Get the alert with the specified id.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (escalationRules, nextEscalationUser)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts/{id}/suggested-responders", + "method": "getAssignableResponders", + "httpMethod": "get", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Get available (https://api.ilert.com/api-docs responders for the alert with the specified id.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "lang", + "schema": "string", + "description": "locale for response text eg. 'en' or 'de'" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts/{id}/responders", + "method": "addResponder", + "httpMethod": "post", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Add an additional responder to the alert.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "404", + "description": "Responder did not exist" + }, + { + "statusCode": "405", + "description": "Responder is already present on the alert" + } + ] + }, + { + "url": "/alerts/{id}/responders/{user-id}", + "method": "removeResponder", + "httpMethod": "delete", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Remove a responder from the alert.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "userId", + "schema": "string", + "required": true, + "description": "numeric user id", + "example": "USER-ID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Responder has been removed" + }, + { + "statusCode": "404", + "description": "Responder did not exist" + } + ] + }, + { + "url": "/alerts/{id}/assign", + "method": "assignAlertTo", + "httpMethod": "put", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Assign the alert.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "user", + "schema": "string", + "description": "numeric user id" + }, + { + "name": "policy", + "schema": "string", + "description": "numeric policy id" + }, + { + "name": "schedule", + "schema": "string", + "description": "numeric schedule id" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts/{id}/accept", + "method": "acceptAlert", + "httpMethod": "put", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Accept the Alert.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts/{id}/resolve", + "method": "resolveAlert", + "httpMethod": "put", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Resolve the alert.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts/{id}/notifications", + "method": "getNotifications", + "httpMethod": "get", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Get notifications for the specified alert.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts/{id}/log-entries", + "method": "getLogEntries", + "httpMethod": "get", + "tag": "Alerts", + "typeScriptTag": "alerts", + "description": "Get log entries for the specified alert.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "lang", + "schema": "string", + "description": "log entry language" + }, + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (https://api.ilert.com/api-docs" + }, + { + "name": "filterTypes", + "schema": "array", + "description": "filter-type (https://api.ilert.com/api-docs of the log" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts/{id}/actions", + "method": "getAvailableActions", + "httpMethod": "get", + "tag": "Alert Actions", + "typeScriptTag": "alertActions", + "description": "Get available actions for specified alert.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alerts/{id}/actions", + "method": "invokeSpecificAction", + "httpMethod": "post", + "tag": "Alert Actions", + "typeScriptTag": "alertActions", + "description": "Invoke a specific alert action.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "alertActionId", + "schema": "string", + "description": "" + }, + { + "name": "connectorId", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "iconUrl", + "schema": "string", + "description": "" + }, + { + "name": "history", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/schedules", + "method": "listOnCallSchedules", + "httpMethod": "get", + "tag": "Schedules", + "typeScriptTag": "schedules", + "description": "List on-call schedules.", + "parameters": [ + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (currentShift, nextShift, scheduleLayers [only available for RECURRING schedules], shifts [only available for STATIC schedules], past [show shifts in the past, only for STATIC])" + }, + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of schedules.", + "default": 20 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/schedules", + "method": "createNewOnCallSchedule", + "httpMethod": "post", + "tag": "Schedules", + "typeScriptTag": "schedules", + "description": "Create a new on-call schedule.", + "parameters": [ + { + "name": "abortOnGaps", + "schema": "boolean", + "required": false, + "description": "Used for static schedules to prevent creating schedules with gaps" + }, + { + "name": "id", + "schema": "integer", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "timezone", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + }, + { + "name": "scheduleLayers", + "schema": "array", + "description": "" + }, + { + "name": "shifts", + "schema": "array", + "description": "" + }, + { + "name": "showGaps", + "schema": "boolean", + "description": "" + }, + { + "name": "defaultShiftDuration", + "schema": "string", + "description": "" + }, + { + "name": "currentShift", + "schema": "object", + "description": "" + }, + { + "name": "nextShift", + "schema": "object", + "description": "" + }, + { + "name": "teams", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/schedules/{id}", + "method": "deleteScheduleById", + "httpMethod": "delete", + "tag": "Schedules", + "typeScriptTag": "schedules", + "description": "Delete the on-call schedule with the specified id.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "empty response" + } + ] + }, + { + "url": "/schedules/{id}", + "method": "getById", + "httpMethod": "get", + "tag": "Schedules", + "typeScriptTag": "schedules", + "description": "Get the on-call schedule with the specified id.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (currentShift, nextShift, scheduleLayers [only available for RECURRING schedules], shifts [only available for STATIC schedules], past [show shifts in the past, only for STATIC])" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/schedules/{id}", + "method": "updateOnCallSchedule", + "httpMethod": "put", + "tag": "Schedules", + "typeScriptTag": "schedules", + "description": "Update an on-call schedule.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "abortOnGaps", + "schema": "boolean", + "required": false, + "description": "Used for static schedules to prevent updating schedules with gaps" + }, + { + "name": "id", + "schema": "integer", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "timezone", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + }, + { + "name": "scheduleLayers", + "schema": "array", + "description": "" + }, + { + "name": "shifts", + "schema": "array", + "description": "" + }, + { + "name": "showGaps", + "schema": "boolean", + "description": "" + }, + { + "name": "defaultShiftDuration", + "schema": "string", + "description": "" + }, + { + "name": "currentShift", + "schema": "object", + "description": "" + }, + { + "name": "nextShift", + "schema": "object", + "description": "" + }, + { + "name": "teams", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/schedules/{id}/shifts", + "method": "getShiftsByIdAndDateRange", + "httpMethod": "get", + "tag": "Schedules", + "typeScriptTag": "schedules", + "description": "Get shifts for the specified schedule and date range.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "from", + "schema": "string", + "description": "from date, default is start of last month" + }, + { + "name": "until", + "schema": "string", + "description": "until date, default is from date plus 3 months" + }, + { + "name": "excludeOverrides", + "schema": "boolean", + "description": "if true, shifts won't include overrides", + "default": false + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/schedules/{id}/overrides", + "method": "getOverridesById", + "httpMethod": "get", + "tag": "Schedules", + "typeScriptTag": "schedules", + "description": "Get overrides for the specified schedule.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/schedules/{id}/overrides", + "method": "addOverrideShift", + "httpMethod": "put", + "tag": "Schedules", + "typeScriptTag": "schedules", + "description": "Add an override shift to a schedule.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "user", + "schema": "object", + "description": "" + }, + { + "name": "end", + "schema": "string", + "description": "" + }, + { + "name": "start", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/schedules/{id}/user-on-call", + "method": "getUserOnCall", + "httpMethod": "get", + "tag": "Schedules", + "typeScriptTag": "schedules", + "description": "Get the user (wrapped in a shift object) on-call for the specified schedule.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "204", + "description": "if no user is on-call" + } + ] + }, + { + "url": "/on-calls", + "method": "listWithFilters", + "httpMethod": "get", + "tag": "On-Calls", + "typeScriptTag": "onCalls", + "description": "List on-calls with flexible filters", + "parameters": [ + { + "name": "policies", + "schema": "number", + "required": false, + "description": "escalation policy ids to filter on call duties for" + }, + { + "name": "policyLevels", + "schema": "string", + "required": false, + "description": "can be provided instead of 'policies', must be a serialised and urlencoded JSON object e.g. ?policy-levels=\"{ \"id\": 12, \"level\": 1 }\" where id is the policy id and level is the escalation level that should be included" + }, + { + "name": "schedules", + "schema": "number", + "required": false, + "description": "on call schedule ids to filter on call duties for" + }, + { + "name": "users", + "schema": "number", + "required": false, + "description": "user ids to filter on call duties for" + }, + { + "name": "expand", + "schema": "string", + "required": false, + "description": "include full entities for: policy, escalationPolicy or user" + }, + { + "name": "from", + "schema": "string", + "required": false, + "description": "date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, start of the time range, may not exceed 3 months in total span, defaults to current time" + }, + { + "name": "until", + "schema": "string", + "required": false, + "description": "date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, end of the time range, must be after 'from', defaults to current time" + }, + { + "name": "timezone", + "schema": "string", + "required": false, + "description": "Time zone in which the results will be rendered, defaults to UTC" + }, + { + "name": "startIndex", + "schema": "number", + "required": false, + "description": "offset for the search results, defaults to 0" + }, + { + "name": "maxResults", + "schema": "number", + "required": false, + "description": "limit for the search results, defaults to 50, may not exceed 250" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alert-sources", + "method": "listSources", + "httpMethod": "get", + "tag": "Alert Sources", + "typeScriptTag": "alertSources", + "description": "List alert sources.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of alert sources.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alert-sources", + "method": "createNewSource", + "httpMethod": "post", + "tag": "Alert Sources", + "typeScriptTag": "alertSources", + "description": "Create a new alert source.", + "parameters": [ + { + "name": "id", + "schema": "integer", + "required": false, + "description": "" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "iconUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "lightIconUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "darkIconUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "escalationPolicy", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "integrationType", + "schema": "string", + "required": true, + "description": "", + "example": "INTEGRATIONTYPE" + }, + { + "name": "integrationKey", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "integrationUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "autoResolutionTimeout", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertGroupingWindow", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertCreation", + "schema": "string", + "required": false, + "description": "", + "default": "ONE_ALERT_PER_EMAIL" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "emailFiltered", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "emailResolveFiltered", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "active", + "schema": "boolean", + "required": false, + "description": "", + "default": true + }, + { + "name": "emailPredicates", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "emailResolvePredicates", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "resolveKeyExtractor", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "filterOperator", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "resolveFilterOperator", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertPriorityRule", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "supportHours", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "heartbeat", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "bidirectional", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "summaryTemplate", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "detailsTemplate", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "routingTemplate", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "linkTemplates", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "priorityTemplate", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/alert-sources/{id}", + "method": "deleteSpecifiedSource", + "httpMethod": "delete", + "tag": "Alert Sources", + "typeScriptTag": "alertSources", + "description": "Delete the specified alert source.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/alert-sources/{id}", + "method": "getByIdOrApiKey", + "httpMethod": "get", + "tag": "Alert Sources", + "typeScriptTag": "alertSources", + "description": "Get the alert source with specified id or alternatively api key.", + "parameters": [ + { + "name": "sourceId", + "schema": "string", + "required": true, + "description": "numeric source id or api key", + "example": "SOURCE-ID" + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (detailsTemplate, summaryTemplate, routingTemplate, linkTemplates, priorityTemplate, textTemplate)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alert-sources/{id}", + "method": "updateExistingSource", + "httpMethod": "put", + "tag": "Alert Sources", + "typeScriptTag": "alertSources", + "description": "Update an existing alert source.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "integer", + "required": false, + "description": "" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "iconUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "lightIconUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "darkIconUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "escalationPolicy", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "integrationType", + "schema": "string", + "required": true, + "description": "", + "example": "INTEGRATIONTYPE" + }, + { + "name": "integrationKey", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "integrationUrl", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "autoResolutionTimeout", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertGroupingWindow", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertCreation", + "schema": "string", + "required": false, + "description": "", + "default": "ONE_ALERT_PER_EMAIL" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "emailFiltered", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "emailResolveFiltered", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "active", + "schema": "boolean", + "required": false, + "description": "", + "default": true + }, + { + "name": "emailPredicates", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "emailResolvePredicates", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "resolveKeyExtractor", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "filterOperator", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "resolveFilterOperator", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertPriorityRule", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "supportHours", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "heartbeat", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "bidirectional", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "summaryTemplate", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "detailsTemplate", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "routingTemplate", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "linkTemplates", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "priorityTemplate", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/support-hours", + "method": "list", + "httpMethod": "get", + "tag": "Support Hours", + "typeScriptTag": "supportHours", + "description": "List support hours.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of support hours.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/support-hours", + "method": "createNewSupportHour", + "httpMethod": "post", + "tag": "Support Hours", + "typeScriptTag": "supportHours", + "description": "Create a new support hour.", + "parameters": [ + { + "name": "id", + "schema": "integer", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "timezone", + "schema": "string", + "required": true, + "description": "", + "example": "TIMEZONE" + }, + { + "name": "supportDays", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/support-hours/{id}", + "method": "deleteSpecifiedSupportHour", + "httpMethod": "delete", + "tag": "Support Hours", + "typeScriptTag": "supportHours", + "description": "Delete the specified support hour.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/support-hours/{id}", + "method": "getById", + "httpMethod": "get", + "tag": "Support Hours", + "typeScriptTag": "supportHours", + "description": "Get the support hour with specified id.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/support-hours/{id}", + "method": "updateExistingHour", + "httpMethod": "put", + "tag": "Support Hours", + "typeScriptTag": "supportHours", + "description": "Update an existing support hour.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "integer", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "timezone", + "schema": "string", + "required": true, + "description": "", + "example": "TIMEZONE" + }, + { + "name": "supportDays", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/maintenance-windows", + "method": "list", + "httpMethod": "get", + "tag": "Maintenance Windows", + "typeScriptTag": "maintenanceWindows", + "description": "List maintenance windows.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/maintenance-windows", + "method": "createNewWindow", + "httpMethod": "post", + "tag": "Maintenance Windows", + "typeScriptTag": "maintenanceWindows", + "description": "Create a new maintenance window.", + "parameters": [ + { + "name": "summary", + "schema": "string", + "description": "" + }, + { + "name": "description", + "schema": "string", + "description": "" + }, + { + "name": "timezone", + "schema": "string", + "description": "" + }, + { + "name": "start", + "schema": "string", + "description": "" + }, + { + "name": "end", + "schema": "string", + "description": "" + }, + { + "name": "alertSources", + "schema": "array", + "description": "" + }, + { + "name": "services", + "schema": "array", + "description": "" + }, + { + "name": "createdBy", + "schema": "string", + "description": "" + }, + { + "name": "notifications", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/maintenance-windows/{id}", + "method": "removeById", + "httpMethod": "delete", + "tag": "Maintenance Windows", + "typeScriptTag": "maintenanceWindows", + "description": "Delete the specified maintenance window.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/maintenance-windows/{id}", + "method": "getById", + "httpMethod": "get", + "tag": "Maintenance Windows", + "typeScriptTag": "maintenanceWindows", + "description": "Get the maintenance window with specified id.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/maintenance-windows/{id}", + "method": "updateExistingWindow", + "httpMethod": "put", + "tag": "Maintenance Windows", + "typeScriptTag": "maintenanceWindows", + "description": "Update an existing maintenance window.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "summary", + "schema": "string", + "description": "" + }, + { + "name": "description", + "schema": "string", + "description": "" + }, + { + "name": "timezone", + "schema": "string", + "description": "" + }, + { + "name": "start", + "schema": "string", + "description": "" + }, + { + "name": "end", + "schema": "string", + "description": "" + }, + { + "name": "alertSources", + "schema": "array", + "description": "" + }, + { + "name": "services", + "schema": "array", + "description": "" + }, + { + "name": "createdBy", + "schema": "string", + "description": "" + }, + { + "name": "notifications", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/escalation-policies", + "method": "listPolicies", + "httpMethod": "get", + "tag": "Escalation Policies", + "typeScriptTag": "escalationPolicies", + "description": "List escalation policies.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of escalation policies.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/escalation-policies", + "method": "createNewPolicy", + "httpMethod": "post", + "tag": "Escalation Policies", + "typeScriptTag": "escalationPolicies", + "description": "Create a new escalation policy.", + "parameters": [ + { + "name": "id", + "schema": "integer", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "escalationRules", + "schema": "array", + "required": true, + "description": "" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "repeating", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "frequency", + "schema": "integer", + "required": false, + "description": "", + "default": 1 + }, + { + "name": "delayMin", + "schema": "integer", + "required": false, + "description": "", + "default": 0 + }, + { + "name": "routingKey", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/escalation-policies/{id}", + "method": "deleteSpecificPolicy", + "httpMethod": "delete", + "tag": "Escalation Policies", + "typeScriptTag": "escalationPolicies", + "description": "Delete the specified escalation policy.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "if deletion was successful" + } + ] + }, + { + "url": "/escalation-policies/{id}", + "method": "getById", + "httpMethod": "get", + "tag": "Escalation Policies", + "typeScriptTag": "escalationPolicies", + "description": "Get escalation policy with the specified id.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/escalation-policies/{id}", + "method": "updateExistingPolicy", + "httpMethod": "put", + "tag": "Escalation Policies", + "typeScriptTag": "escalationPolicies", + "description": "Update an existing escalation policy.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "integer", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "escalationRules", + "schema": "array", + "required": true, + "description": "" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "repeating", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "frequency", + "schema": "integer", + "required": false, + "description": "", + "default": 1 + }, + { + "name": "delayMin", + "schema": "integer", + "required": false, + "description": "", + "default": 0 + }, + { + "name": "routingKey", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/series/{key}", + "method": "ingestMetricSeries", + "httpMethod": "post", + "tag": "Series", + "typeScriptTag": "series", + "description": "Ingest a series for a metric", + "parameters": [ + { + "name": "key", + "schema": "string", + "required": true, + "description": "api key of resource", + "example": "KEY" + } + ], + "responses": [ + { + "statusCode": "202", + "description": "The time points have been accepted" + } + ] + }, + { + "url": "/events", + "method": "postEventToIlert", + "httpMethod": "post", + "tag": "Events", + "typeScriptTag": "events", + "description": "Post an event to ilert.", + "parameters": [ + { + "name": "summary", + "schema": "string", + "required": true, + "description": "", + "example": "SUMMARY" + }, + { + "name": "apiKey", + "schema": "string", + "required": true, + "description": "", + "example": "APIKEY" + }, + { + "name": "eventType", + "schema": "string", + "required": true, + "description": "", + "example": "EVENTTYPE" + }, + { + "name": "details", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertKey", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "priority", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "images", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "links", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "comments", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "customDetails", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "routingKey", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "202", + "description": "The event has been accepted" + } + ] + }, + { + "url": "/heartbeats/{key}", + "method": "pingAlertSource", + "httpMethod": "get", + "tag": "Heartbeats", + "typeScriptTag": "heartbeats", + "description": "Ping heartbeat alert source.", + "parameters": [ + { + "name": "key", + "schema": "string", + "required": true, + "description": "api key of resource", + "example": "KEY" + } + ], + "responses": [ + { + "statusCode": "202", + "description": "Arbitrary accept response" + } + ] + }, + { + "url": "/heartbeats/{key}", + "method": "pingAlertSource", + "httpMethod": "head", + "tag": "Heartbeats", + "typeScriptTag": "heartbeats", + "description": "Ping heartbeat alert source.", + "parameters": [ + { + "name": "key", + "schema": "string", + "required": true, + "description": "api key of resource", + "example": "KEY" + } + ], + "responses": [ + { + "statusCode": "202", + "description": "Arbitrary accept response" + } + ] + }, + { + "url": "/heartbeats/{key}", + "method": "pingAlertSource", + "httpMethod": "post", + "tag": "Heartbeats", + "typeScriptTag": "heartbeats", + "description": "Ping heartbeat alert source.", + "parameters": [ + { + "name": "key", + "schema": "string", + "required": true, + "description": "api key of resource", + "example": "KEY" + } + ], + "responses": [ + { + "statusCode": "202", + "description": "Arbitrary accept response" + } + ] + }, + { + "url": "/alert-actions", + "method": "getList", + "httpMethod": "get", + "tag": "Alert Actions", + "typeScriptTag": "alertActions", + "description": "Get alert actions.", + "parameters": [ + { + "name": "source", + "schema": "number", + "description": "alert source id" + }, + { + "name": "connector", + "schema": "string", + "description": "connector id" + }, + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of alert actions.", + "default": 100 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alert-actions", + "method": "createNewAction", + "httpMethod": "post", + "tag": "Alert Actions", + "typeScriptTag": "alertActions", + "description": "Create a new alert action.", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertSources", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "connectorId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "connectorType", + "schema": "string", + "required": true, + "description": "", + "example": "CONNECTORTYPE" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "createdAt", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "triggerMode", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "bidirectional", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "delaySec", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "triggerTypes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "alertFilter", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "params", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alert-actions/{id}", + "method": "removeSpecificAction", + "httpMethod": "delete", + "tag": "Alert Actions", + "typeScriptTag": "alertActions", + "description": "Remove a specific alert action.", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "entity ID", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/alert-actions/{id}", + "method": "getSpecificAction", + "httpMethod": "get", + "tag": "Alert Actions", + "typeScriptTag": "alertActions", + "description": "Get a specific alert action.", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "entity ID", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/alert-actions/{id}", + "method": "updateSpecificAlertAction", + "httpMethod": "put", + "tag": "Alert Actions", + "typeScriptTag": "alertActions", + "description": "Update the specific alert action. (note: type cannot be changed)", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "entity ID", + "example": "ID" + }, + { + "name": "id", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "alertSources", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "connectorId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "connectorType", + "schema": "string", + "required": true, + "description": "", + "example": "CONNECTORTYPE" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "createdAt", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "triggerMode", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "bidirectional", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "delaySec", + "schema": "number", + "required": false, + "description": "" + }, + { + "name": "triggerTypes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "alertFilter", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "params", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/connectors", + "method": "getAvailableConnectors", + "httpMethod": "get", + "tag": "Connectors", + "typeScriptTag": "connectors", + "description": "Get connectors.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/connectors", + "method": "createNewConnector", + "httpMethod": "post", + "tag": "Connectors", + "typeScriptTag": "connectors", + "description": "Create a new connector.", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "", + "example": "TYPE" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "createdAt", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "params", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/connectors/{id}", + "method": "removeSpecificConnector", + "httpMethod": "delete", + "tag": "Connectors", + "typeScriptTag": "connectors", + "description": "Remove a specific connector.", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "entity ID", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/connectors/{id}", + "method": "getSpecificConnector", + "httpMethod": "get", + "tag": "Connectors", + "typeScriptTag": "connectors", + "description": "Get a specific connector.", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "entity ID", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/connectors/{id}", + "method": "updateSpecificConnector", + "httpMethod": "put", + "tag": "Connectors", + "typeScriptTag": "connectors", + "description": "Update the specific connector. (note: type cannot be changed)", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "entity ID", + "example": "ID" + }, + { + "name": "id", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "", + "example": "TYPE" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "createdAt", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "params", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/teams", + "method": "getAll", + "httpMethod": "get", + "tag": "Teams", + "typeScriptTag": "teams", + "description": "Get teams.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + }, + { + "name": "members", + "schema": "number", + "required": false, + "description": "optional, filter teams for specific members (currently only a single occurrence of this param is allowed)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/teams", + "method": "createNewTeam", + "httpMethod": "post", + "tag": "Teams", + "typeScriptTag": "teams", + "description": "Create a new team.", + "parameters": [ + { + "name": "id", + "schema": "integer", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "visibility", + "schema": "string", + "description": "" + }, + { + "name": "members", + "schema": "array", + "description": "" + }, + { + "name": "createdAt", + "schema": "string", + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/teams/{id}", + "method": "removeSpecificTeam", + "httpMethod": "delete", + "tag": "Teams", + "typeScriptTag": "teams", + "description": "Remove a specific team.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/teams/{id}", + "method": "getDetails", + "httpMethod": "get", + "tag": "Teams", + "typeScriptTag": "teams", + "description": "Get a specific team.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/teams/{id}", + "method": "updateSpecificTeam", + "httpMethod": "put", + "tag": "Teams", + "typeScriptTag": "teams", + "description": "Update the specific team", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "integer", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "visibility", + "schema": "string", + "description": "" + }, + { + "name": "members", + "schema": "array", + "description": "" + }, + { + "name": "createdAt", + "schema": "string", + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/teams/{id}/members", + "method": "addNewMember", + "httpMethod": "post", + "tag": "Teams", + "typeScriptTag": "teams", + "description": "Add a new team member to specific team", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "user", + "schema": "object", + "description": "" + }, + { + "name": "role", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/teams/{id}/members/{id}", + "method": "removeSpecificMember", + "httpMethod": "delete", + "tag": "Teams", + "typeScriptTag": "teams", + "description": "Remove a specific member of a specific team.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/reports/alerts", + "method": "listAlertMetrics", + "httpMethod": "get", + "tag": "Reports", + "typeScriptTag": "reports", + "description": "List alert metrics for the requested resources", + "parameters": [ + { + "name": "sources", + "schema": "number", + "required": false, + "description": "alert source ids to filter metrics for" + }, + { + "name": "policies", + "schema": "number", + "required": false, + "description": "escalation policy ids to filter metrics for" + }, + { + "name": "numbers", + "schema": "string", + "required": false, + "description": "phone numbers of call routing numbers to filter metrics for" + }, + { + "name": "from", + "schema": "string", + "required": true, + "description": "date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, start of the time range, may not exceed 1 year in total span", + "example": "FROM" + }, + { + "name": "until", + "schema": "string", + "required": true, + "description": "date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, end of the time range, must be after 'from', must not be in the future", + "example": "UNTIL" + }, + { + "name": "timezone", + "schema": "string", + "required": false, + "description": "Time zone in which the results will be rendered, defaults to tenant's configured default timezone" + }, + { + "name": "metric", + "schema": "string", + "required": false, + "description": "Describes the metric that should be fetched choose one of: COUNT, MTTA or MTTR - defaults to COUNT" + }, + { + "name": "groupBy", + "schema": "string", + "required": false, + "description": "Defines the grouping of metrics, choose one of: DAY, WEEK or MONTH - defaults to WEEK" + }, + { + "name": "priority", + "schema": "string", + "required": false, + "description": "Sets the priority filter that should be applied, choose one of: LOW, HIGH or ALL - defaults to ALL" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/reports/alerts/summary", + "method": "summarizeAlertMetrics", + "httpMethod": "get", + "tag": "Reports", + "typeScriptTag": "reports", + "description": "Summarize a list of alert metrics", + "parameters": [ + { + "name": "sources", + "schema": "number", + "required": false, + "description": "alert source ids to filter metrics for" + }, + { + "name": "policies", + "schema": "number", + "required": false, + "description": "escalation policy ids to filter metrics for" + }, + { + "name": "numbers", + "schema": "string", + "required": false, + "description": "phone numbers of call routing numbers to filter metrics for" + }, + { + "name": "from", + "schema": "string", + "required": true, + "description": "date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, start of the time range, may not exceed 1 year in total span", + "example": "FROM" + }, + { + "name": "until", + "schema": "string", + "required": true, + "description": "date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, end of the time range, must be after 'from', must not be in the future", + "example": "UNTIL" + }, + { + "name": "timezone", + "schema": "string", + "required": false, + "description": "Time zone in which the results will be rendered, defaults to tenant's configured default timezone" + }, + { + "name": "metric", + "schema": "string", + "required": false, + "description": "Describes the metric that should be fetched choose one of: COUNT, MTTA or MTTR - defaults to COUNT" + }, + { + "name": "groupBy", + "schema": "string", + "required": false, + "description": "Defines the grouping of metrics, choose one of: DAY, WEEK or MONTH - defaults to WEEK" + }, + { + "name": "priority", + "schema": "string", + "required": false, + "description": "Sets the priority filter that should be applied, choose one of: LOW, HIGH or ALL - defaults to ALL" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/reports/api-keys/usage", + "method": "listApiKeyUsageMetrics", + "httpMethod": "get", + "tag": "Reports", + "typeScriptTag": "reports", + "description": "List API key usage metrics for the requested resources", + "parameters": [ + { + "name": "scopes", + "schema": "string", + "required": false, + "description": "scopes of our API resources e.g. alert see https://docs.ilert.com/rest-api/developing-ilert-apps/token-lifetimes-error-codes-app-verification-etc.#ilert-oauth2-scopes" + }, + { + "name": "from", + "schema": "string", + "required": true, + "description": "date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, start of the time range, may not exceed 1 month (31 days) in total span (use this to paginate)", + "example": "FROM" + }, + { + "name": "until", + "schema": "string", + "required": true, + "description": "date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, end of the time range, must be after 'from', must not be in the future (use this to paginate)", + "example": "UNTIL" + }, + { + "name": "timezone", + "schema": "string", + "required": false, + "description": "Time zone in which the results will be rendered, defaults to tenant's configured default timezone" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incident-templates", + "method": "getList", + "httpMethod": "get", + "tag": "Incident Templates", + "typeScriptTag": "incidentTemplates", + "description": "Get incident templates.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incident-templates", + "method": "createNewTemplate", + "httpMethod": "post", + "tag": "Incident Templates", + "typeScriptTag": "incidentTemplates", + "description": "Create a new incident template.", + "parameters": [ + { + "name": "summary", + "schema": "string", + "description": "" + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "message", + "schema": "string", + "description": "" + }, + { + "name": "sendNotification", + "schema": "boolean", + "description": "" + }, + { + "name": "teams", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incident-templates/{id}", + "method": "removeSpecificTemplate", + "httpMethod": "delete", + "tag": "Incident Templates", + "typeScriptTag": "incidentTemplates", + "description": "Remove a specific incident template.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/incident-templates/{id}", + "method": "getSpecificTemplate", + "httpMethod": "get", + "tag": "Incident Templates", + "typeScriptTag": "incidentTemplates", + "description": "Get a specific incident template.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incident-templates/{id}", + "method": "updateSpecificTemplate", + "httpMethod": "put", + "tag": "Incident Templates", + "typeScriptTag": "incidentTemplates", + "description": "Update the specific incident template", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "summary", + "schema": "string", + "description": "" + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "message", + "schema": "string", + "description": "" + }, + { + "name": "sendNotification", + "schema": "boolean", + "description": "" + }, + { + "name": "teams", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/services", + "method": "listAvailableServices", + "httpMethod": "get", + "tag": "Services", + "typeScriptTag": "services", + "description": "Get services.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of services. (Note: when using ?include maximum is reduced to 25)", + "default": 10 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (subscribed, uptime, incidents)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/services", + "method": "createService", + "httpMethod": "post", + "tag": "Services", + "typeScriptTag": "services", + "description": "Create a new service.", + "parameters": [ + { + "name": "description", + "schema": "string", + "description": "" + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "oneOpenIncidentOnly", + "schema": "boolean", + "description": "" + }, + { + "name": "showUptimeHistory", + "schema": "boolean", + "description": "" + }, + { + "name": "teams", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/services/{id}", + "method": "removeSpecificService", + "httpMethod": "delete", + "tag": "Services", + "typeScriptTag": "services", + "description": "Remove a specific service.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/services/{id}", + "method": "getSpecificService", + "httpMethod": "get", + "tag": "Services", + "typeScriptTag": "services", + "description": "Get a specific service.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (subscribed, uptime, incidents)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/services/{id}", + "method": "updateSpecificService", + "httpMethod": "put", + "tag": "Services", + "typeScriptTag": "services", + "description": "Update the specific service", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "description", + "schema": "string", + "description": "" + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "oneOpenIncidentOnly", + "schema": "boolean", + "description": "" + }, + { + "name": "showUptimeHistory", + "schema": "boolean", + "description": "" + }, + { + "name": "teams", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/automation-rules", + "method": "getDeprecatedRules", + "httpMethod": "get", + "tag": "Automation Rules", + "typeScriptTag": "automationRules", + "description": "Get automation rules.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + }, + { + "name": "service", + "schema": "number", + "required": true, + "description": "The service id for which automation rules are filtered for, this param is required", + "example": 0 + }, + { + "name": "source", + "schema": "number", + "required": false, + "description": "The alert source id for which automation rules are filtered for, this param is an alternative to service" + }, + { + "name": "statusPage", + "schema": "number", + "required": false, + "description": "The status page id for which automation rules are filtered for, this param is an alternative to service" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/automation-rules", + "method": "createNewRule", + "httpMethod": "post", + "tag": "Automation Rules", + "typeScriptTag": "automationRules", + "description": "Create a new automation rule.", + "parameters": [ + { + "name": "id", + "schema": "string", + "description": "" + }, + { + "name": "alertType", + "schema": "string", + "description": "" + }, + { + "name": "resolveIncident", + "schema": "boolean", + "description": "" + }, + { + "name": "resolveService", + "schema": "boolean", + "description": "" + }, + { + "name": "serviceStatus", + "schema": "string", + "description": "" + }, + { + "name": "template", + "schema": "object", + "description": "" + }, + { + "name": "service", + "schema": "object", + "description": "" + }, + { + "name": "alertSource", + "schema": "object", + "description": "" + }, + { + "name": "sendNotification", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/automation-rules/{id}", + "method": "removeSpecificRule", + "httpMethod": "delete", + "tag": "Automation Rules", + "typeScriptTag": "automationRules", + "description": "Remove a specific automation rule.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/automation-rules/{id}", + "method": "getSpecificRule", + "httpMethod": "get", + "tag": "Automation Rules", + "typeScriptTag": "automationRules", + "description": "Get a specific automation rule.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/automation-rules/{id}", + "method": "updateSpecificRule", + "httpMethod": "put", + "tag": "Automation Rules", + "typeScriptTag": "automationRules", + "description": "Update the specific automation rule", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "string", + "description": "" + }, + { + "name": "alertType", + "schema": "string", + "description": "" + }, + { + "name": "resolveIncident", + "schema": "boolean", + "description": "" + }, + { + "name": "resolveService", + "schema": "boolean", + "description": "" + }, + { + "name": "serviceStatus", + "schema": "string", + "description": "" + }, + { + "name": "template", + "schema": "object", + "description": "" + }, + { + "name": "service", + "schema": "object", + "description": "" + }, + { + "name": "alertSource", + "schema": "object", + "description": "" + }, + { + "name": "sendNotification", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incidents", + "method": "getIncidentList", + "httpMethod": "get", + "tag": "Incidents", + "typeScriptTag": "incidents", + "description": "Get incidents.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of incidents. (Note: when using ?include maximum is reduced to 25)", + "default": 10 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (https://api.ilert.com/api-docs" + }, + { + "name": "states", + "schema": "array", + "description": "state of the alert" + }, + { + "name": "services", + "schema": "array", + "description": "service IDs of the incident's affected services" + }, + { + "name": "from", + "schema": "string", + "description": "from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z, based on reportTime" + }, + { + "name": "until", + "schema": "string", + "description": "until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z, based on reportTime" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incidents", + "method": "createNewIncident", + "httpMethod": "post", + "tag": "Incidents", + "typeScriptTag": "incidents", + "description": "Create a new incident.", + "parameters": [ + { + "name": "summary", + "schema": "string", + "description": "" + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "message", + "schema": "string", + "description": "" + }, + { + "name": "sendNotification", + "schema": "boolean", + "description": "" + }, + { + "name": "createdAt", + "schema": "string", + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "description": "" + }, + { + "name": "affectedServices", + "schema": "array", + "description": "" + }, + { + "name": "resolvedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incidents/publish-info", + "method": "forecastAffectedSubscribersAndStatusPages", + "httpMethod": "post", + "tag": "Incidents", + "typeScriptTag": "incidents", + "description": "Forecast the affected subscribers and status pages", + "parameters": [ + { + "name": "summary", + "schema": "string", + "description": "" + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "message", + "schema": "string", + "description": "" + }, + { + "name": "sendNotification", + "schema": "boolean", + "description": "" + }, + { + "name": "createdAt", + "schema": "string", + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "description": "" + }, + { + "name": "affectedServices", + "schema": "array", + "description": "" + }, + { + "name": "resolvedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incidents/{id}", + "method": "getSpecificIncident", + "httpMethod": "get", + "tag": "Incidents", + "typeScriptTag": "incidents", + "description": "Get a specific incident.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (subscribed, affectedTeams, history)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incidents/{id}", + "method": "updateSpecificIncident", + "httpMethod": "put", + "tag": "Incidents", + "typeScriptTag": "incidents", + "description": "Update the specific incident.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "ifMatch", + "schema": "string", + "required": false, + "description": "Should be the ETag response header retrieved from GET /incidents/{id} to prevent updating the incident based on outdated information. Will return 412 status code in case of conflict." + }, + { + "name": "summary", + "schema": "string", + "description": "" + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "message", + "schema": "string", + "description": "" + }, + { + "name": "sendNotification", + "schema": "boolean", + "description": "" + }, + { + "name": "createdAt", + "schema": "string", + "description": "" + }, + { + "name": "updatedAt", + "schema": "string", + "description": "" + }, + { + "name": "affectedServices", + "schema": "array", + "description": "" + }, + { + "name": "resolvedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incidents/{id}/private-subscribers", + "method": "getPrivateSubscribers", + "httpMethod": "get", + "tag": "Incidents", + "typeScriptTag": "incidents", + "description": "Get the subscribers (users and teams) of an incident", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/incidents/{id}/private-subscribers", + "method": "addSubscribers", + "httpMethod": "post", + "tag": "Incidents", + "typeScriptTag": "incidents", + "description": "Add subscribers (users and teams) to an incident", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + } + ] + }, + { + "url": "/services/{id}/private-subscribers", + "method": "getSubscribers", + "httpMethod": "get", + "tag": "Services", + "typeScriptTag": "services", + "description": "Get the subscribers (users and teams) of a service", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/services/{id}/private-subscribers", + "method": "setPrivateSubscribers", + "httpMethod": "put", + "tag": "Services", + "typeScriptTag": "services", + "description": "Set subscribers (users and teams) of a service", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + } + ] + }, + { + "url": "/status-pages", + "method": "getStatusPages", + "httpMethod": "get", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Get status pages.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of status pages.", + "default": 25 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (https://api.ilert.com/api-docs" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/status-pages", + "method": "createNewStatusPage", + "httpMethod": "post", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Create a new status page.", + "parameters": [ + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "domain", + "schema": "string", + "description": "" + }, + { + "name": "subdomain", + "schema": "string", + "description": "" + }, + { + "name": "timezone", + "schema": "string", + "description": "" + }, + { + "name": "faviconUrl", + "schema": "string", + "description": "" + }, + { + "name": "logoUrl", + "schema": "string", + "description": "" + }, + { + "name": "visibility", + "schema": "string", + "description": "" + }, + { + "name": "hiddenFromSearch", + "schema": "boolean", + "description": "" + }, + { + "name": "showSubscribeAction", + "schema": "boolean", + "description": "" + }, + { + "name": "showIncidentHistoryOption", + "schema": "boolean", + "description": "" + }, + { + "name": "pageTitle", + "schema": "string", + "description": "" + }, + { + "name": "pageDescription", + "schema": "string", + "description": "" + }, + { + "name": "pageLayout", + "schema": "string", + "description": "" + }, + { + "name": "logoRedirectUrl", + "schema": "string", + "description": "" + }, + { + "name": "activated", + "schema": "boolean", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "teams", + "schema": "array", + "description": "" + }, + { + "name": "services", + "schema": "array", + "description": "" + }, + { + "name": "metrics", + "schema": "array", + "description": "" + }, + { + "name": "ipWhitelist", + "schema": "array", + "description": "" + }, + { + "name": "structure", + "schema": "object", + "description": "" + }, + { + "name": "appearance", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}", + "method": "removeSpecificPage", + "httpMethod": "delete", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Remove a specific status page.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/status-pages/{id}", + "method": "getPageDetails", + "httpMethod": "get", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Get a specific status page.", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (subscribed, uptime, groups, structure). Note: structure is always included by default." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}", + "method": "updateSpecificPage", + "httpMethod": "put", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Update the specific status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "domain", + "schema": "string", + "description": "" + }, + { + "name": "subdomain", + "schema": "string", + "description": "" + }, + { + "name": "timezone", + "schema": "string", + "description": "" + }, + { + "name": "faviconUrl", + "schema": "string", + "description": "" + }, + { + "name": "logoUrl", + "schema": "string", + "description": "" + }, + { + "name": "visibility", + "schema": "string", + "description": "" + }, + { + "name": "hiddenFromSearch", + "schema": "boolean", + "description": "" + }, + { + "name": "showSubscribeAction", + "schema": "boolean", + "description": "" + }, + { + "name": "showIncidentHistoryOption", + "schema": "boolean", + "description": "" + }, + { + "name": "pageTitle", + "schema": "string", + "description": "" + }, + { + "name": "pageDescription", + "schema": "string", + "description": "" + }, + { + "name": "pageLayout", + "schema": "string", + "description": "" + }, + { + "name": "logoRedirectUrl", + "schema": "string", + "description": "" + }, + { + "name": "activated", + "schema": "boolean", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "teams", + "schema": "array", + "description": "" + }, + { + "name": "services", + "schema": "array", + "description": "" + }, + { + "name": "metrics", + "schema": "array", + "description": "" + }, + { + "name": "ipWhitelist", + "schema": "array", + "description": "" + }, + { + "name": "structure", + "schema": "object", + "description": "" + }, + { + "name": "appearance", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}/groups", + "method": "getGroups", + "httpMethod": "get", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Get the groups of a status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of entities.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}/groups", + "method": "addGroupToPage", + "httpMethod": "post", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Add a group to a status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}/groups/{group-id}", + "method": "removeGroup", + "httpMethod": "delete", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Remove group from a status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "groupId", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}/groups/{group-id}", + "method": "getSpecificGroup", + "httpMethod": "get", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Get a specific group of a status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "groupId", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}/groups/{group-id}", + "method": "updateGroup", + "httpMethod": "put", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Update a group of a status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "groupId", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}/private-subscribers", + "method": "removeSubscriber", + "httpMethod": "delete", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Remove subscriber (user and team) from a status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}/private-subscribers", + "method": "getPrivateSubscribers", + "httpMethod": "get", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Get the subscribers (users and teams) of a status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}/private-subscribers", + "method": "addSubscriber", + "httpMethod": "post", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Add subscriber (user and team) to a status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "number", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "type", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + } + ] + }, + { + "url": "/status-pages/{id}/private-subscribers", + "method": "setPrivateSubscribers", + "httpMethod": "put", + "tag": "Status Pages", + "typeScriptTag": "statusPages", + "description": "Set subscribers (users and teams) of a status page", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + } + ] + }, + { + "url": "/service-outages", + "method": "getServiceOutages", + "httpMethod": "get", + "tag": "Service Outages", + "typeScriptTag": "serviceOutages", + "description": "Get the outages (including applied overrides) of a specific service", + "parameters": [ + { + "name": "service", + "schema": "number", + "description": "the id of the service for which the outages should be fetched" + }, + { + "name": "from", + "schema": "string", + "description": "from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z" + }, + { + "name": "until", + "schema": "string", + "description": "until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z" + }, + { + "name": "ignoreOverrides", + "schema": "boolean", + "description": "if the outages should not take overrides into account, default is false" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/service-outages/overrides", + "method": "getOverrides", + "httpMethod": "get", + "tag": "Service Outages", + "typeScriptTag": "serviceOutages", + "description": "Get the overrides of a specific service", + "parameters": [ + { + "name": "service", + "schema": "number", + "description": "the id of the service for which the overrides should be fetched" + }, + { + "name": "from", + "schema": "string", + "description": "from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z" + }, + { + "name": "until", + "schema": "string", + "description": "until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/service-outages/overrides", + "method": "overridePartHistory", + "httpMethod": "post", + "tag": "Service Outages", + "typeScriptTag": "serviceOutages", + "description": "Override a part of a service's outage history", + "parameters": [ + { + "name": "id", + "schema": "string", + "description": "" + }, + { + "name": "service", + "schema": "object", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "from", + "schema": "string", + "description": "" + }, + { + "name": "until", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + } + ] + }, + { + "url": "/service-outages/overrides/{id}", + "method": "removeOverride", + "httpMethod": "delete", + "tag": "Service Outages", + "typeScriptTag": "serviceOutages", + "description": "Remove a service outage override", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + } + ] + }, + { + "url": "/service-outages/overrides/{id}", + "method": "getSpecificOverride", + "httpMethod": "get", + "tag": "Service Outages", + "typeScriptTag": "serviceOutages", + "description": "Get the specific service outage override", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/service-outages/overrides/{id}", + "method": "updateOverride", + "httpMethod": "put", + "tag": "Service Outages", + "typeScriptTag": "serviceOutages", + "description": "Update an existing service outage override", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "id", + "schema": "string", + "description": "" + }, + { + "name": "service", + "schema": "object", + "description": "" + }, + { + "name": "status", + "schema": "string", + "description": "" + }, + { + "name": "from", + "schema": "string", + "description": "" + }, + { + "name": "until", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/metric-data-sources", + "method": "list", + "httpMethod": "get", + "tag": "Metric Data Sources", + "typeScriptTag": "metricDataSources", + "description": "Get Metric Data Sources", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of metric data sources", + "default": 10 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/metric-data-sources", + "method": "createNewMetricDataSource", + "httpMethod": "post", + "tag": "Metric Data Sources", + "typeScriptTag": "metricDataSources", + "description": "Create a new Metric Data Source.", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "", + "example": "TYPE" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "metadata", + "schema": "undefined", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/metric-data-sources/{id}", + "method": "deleteSpecificDataSource", + "httpMethod": "delete", + "tag": "Metric Data Sources", + "typeScriptTag": "metricDataSources", + "description": "Delete a specific Metric Data Source", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/metric-data-sources/{id}", + "method": "getSpecificDataSource", + "httpMethod": "get", + "tag": "Metric Data Sources", + "typeScriptTag": "metricDataSources", + "description": "Get a specific Metric Data Source", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/metric-data-sources/{id}", + "method": "updateSpecificDataSource", + "httpMethod": "put", + "tag": "Metric Data Sources", + "typeScriptTag": "metricDataSources", + "description": "Update the specific Metric Data Source", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "", + "example": "TYPE" + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "metadata", + "schema": "undefined", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/metrics", + "method": "getMetrics", + "httpMethod": "get", + "tag": "Metrics", + "typeScriptTag": "metrics", + "description": "Get metrics.", + "parameters": [ + { + "name": "startIndex", + "schema": "integer", + "required": false, + "description": "an integer specifying the starting point (beginning with 0) when paging through a list of entities", + "default": 0 + }, + { + "name": "maxResults", + "schema": "integer", + "required": false, + "description": "the maximum number of results when paging through a list of metrics. (Note: when using ?include maximum is reduced to 25)", + "default": 10 + }, + { + "name": "include", + "schema": "array", + "required": false, + "description": "Describes optional properties that should be included in the response. You may declare multiple. (dataSource, integrationKey)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/metrics", + "method": "createNewMetric", + "httpMethod": "post", + "tag": "Metrics", + "typeScriptTag": "metrics", + "description": "Create a new metric.", + "parameters": [ + { + "name": "description", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "aggregationType", + "schema": "string", + "required": true, + "description": "", + "example": "AGGREGATIONTYPE" + }, + { + "name": "displayType", + "schema": "string", + "required": true, + "description": "", + "example": "DISPLAYTYPE" + }, + { + "name": "interpolateGaps", + "schema": "boolean", + "required": false, + "description": "", + "default": "false" + }, + { + "name": "lockYAxisMax", + "schema": "number", + "required": false, + "description": "", + "default": null + }, + { + "name": "lockYAxisMin", + "schema": "number", + "required": false, + "description": "", + "default": null + }, + { + "name": "mouseOverDecimal", + "schema": "number", + "required": false, + "description": "", + "default": 0 + }, + { + "name": "showValuesOnMouseOver", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "unitLabel", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "metadata", + "schema": "undefined", + "required": false, + "description": "", + "default": null + }, + { + "name": "dataSource", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/metric/{id}", + "method": "deleteSpecificMetric", + "httpMethod": "delete", + "tag": "Metrics", + "typeScriptTag": "metrics", + "description": "Delete the specific Metric", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty body delete response" + } + ] + }, + { + "url": "/metric/{id}", + "method": "getSpecificMetric", + "httpMethod": "get", + "tag": "Metrics", + "typeScriptTag": "metrics", + "description": "Get a specific Metric", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/metric/{id}", + "method": "updateSpecificMetric", + "httpMethod": "put", + "tag": "Metrics", + "typeScriptTag": "metrics", + "description": "Update the specific Metric", + "parameters": [ + { + "name": "id", + "schema": "number", + "required": true, + "description": "entity ID", + "example": 0 + }, + { + "name": "description", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + }, + { + "name": "aggregationType", + "schema": "string", + "required": true, + "description": "", + "example": "AGGREGATIONTYPE" + }, + { + "name": "displayType", + "schema": "string", + "required": true, + "description": "", + "example": "DISPLAYTYPE" + }, + { + "name": "interpolateGaps", + "schema": "boolean", + "required": false, + "description": "", + "default": "false" + }, + { + "name": "lockYAxisMax", + "schema": "number", + "required": false, + "description": "", + "default": null + }, + { + "name": "lockYAxisMin", + "schema": "number", + "required": false, + "description": "", + "default": null + }, + { + "name": "mouseOverDecimal", + "schema": "number", + "required": false, + "description": "", + "default": 0 + }, + { + "name": "showValuesOnMouseOver", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "teams", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "unitLabel", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "metadata", + "schema": "undefined", + "required": false, + "description": "", + "default": null + }, + { + "name": "dataSource", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + } + ], + "repositoryDescription": "ilert is a SaaS company for alerting, on-call management and incident communication and helps companies to increase their digital uptime. B2C and B2B companies from across the globe, including well-known brands such as Bertelsmann, TeamViewer and REWE, trust ilert to empower their operations teams and ensure everything is running smoothly.", + "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/ilert/logo.png", + "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/ilert/openapi.yaml", + "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/ilert/openapi.yaml", + "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/ilert/imagePreview.png", + "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/ilert/favicon.png", + "clientNameCamelCase": "ilert", + "lastUpdated": "2024-03-29T22:11:39.095Z", + "typescriptSdkUsageCode": "import { Ilert } from 'ilert-typescript-sdk';\n\nconst ilert = new Ilert({\n // The Bearer API key of your user more info.\n apiKey: \"AUTHORIZATION\"\n})", + "typescriptSdkFirstRequestCode": "// Delete the specified user.\nconst deleteUserResponse = ilert.users.deleteUser({\n userId: \"USER-ID\"\n})", + "fixedSpecFileName": "ilert-fixed-spec.yaml" +} \ No newline at end of file diff --git a/sdks/db/published/from-custom-request_inmobile.com.json b/sdks/db/published/from-custom-request_inmobile.com.json new file mode 100644 index 0000000000..6f77212e39 --- /dev/null +++ b/sdks/db/published/from-custom-request_inmobile.com.json @@ -0,0 +1,1569 @@ +{ + "securitySchemes": { + "BasicAuth": { + "type": "http", + "description": "Provide Basic Authentiation with an arbitrary username and your api key as password, e.g. some_value_to_be_ignored:your_api_key_here", + "scheme": "basic" + }, + "QueryParameter": { + "type": "apiKey", + "description": "Specify your apikey in the url as https://api.inmobile.com/some/path?apikey=your_api_key_here. This method is only recommended if basic authorization is not possible.", + "name": "apikey", + "in": "query" + } + }, + "apiBaseUrl": "https://api.inmobile.com", + "apiVersion": "version 4", + "apiDescription": "\r\n# Introduction\r\n\r\nThis document is a technical description of our REST API used for external systems to send sms messages and to retrieve a status for each sms message sent and to maintain lists and blacklists.\r\n\r\nIn order to call our API, you need an api key. Log in to your account at https://mm.inmobile.dk, go to the \"API\" menu section and your api key will be available here.\r\n\r\nNOTE: It is required for clients to support tls 1.2 or higher.\r\n\r\n\r\n# Firewall openings\r\n\r\nThis is relevant for status callbacks and incoming SMS messages.\r\n\r\nYou can expect callbacks from one of the following IP ranges:\r\n\r\n* 46.36.205.80/28\r\n* 185.221.37.96/28\r\n\r\nThese are also the ip addresses which will be used for api.inmobile.com and mm.inmobile.dk - ensure access to these 2 ranges are opened in your firewall.", + "apiTitle": "inMobile REST API", + "endpoints": 24, + "sdkMethods": 36, + "schemas": 66, + "parameters": 71, + "originalCustomRequest": { + "type": "GET", + "url": "https://api.inmobile.com/swagger/v1/swagger.json" + }, + "customRequestSpecFilename": "inmobile.com.yaml", + "difficultyScore": 86.75, + "difficulty": "Easy", + "company": "inMobile", + "sdkName": "in-mobile-{language}-sdk", + "clientName": "InMobile", + "metaDescription": "inMobile er en SMS-Gateway testet af over 8.000 brugere. Vi håndterer over 150 mio. SMS-beskeder årligt og tilstræber en oppetid på 100%, men sandheden er 99,99%. \n\nUanset, om det drejer sig om at informere dine kunder, medarbejdere eller andre personer, som er vigtige for din virksomhed, gør inMobile det nemt for de rette personer at få besked på det rette tidspunkt. \n\nDu får adgang til en brugervenlig SMS-Gateway og et gennemtestet API, som du nemt kan integrere med dit eget system eller hjemmeside.\n\nØnsker du at høre mere om vores løsning, er du velkommen til at kontakte os på +45 88 33 66 99 eller på mail salg@inmobile.dk\nVi har åbent alle hverdage mellem kl. 8-17", + "apiStatusUrls": "inherit", + "homepage": "inmobile.com", + "developerDocumentation": "www.inmobile.com/docs/rest-api", + "categories": [ + "messaging", + "sms" + ], + "category": "Phone & SMS", + "methods": [ + { + "url": "/v4/blacklist", + "method": "getAll", + "httpMethod": "get", + "tag": "Blacklist", + "typeScriptTag": "blacklist", + "description": "Returns all blacklists (Paged result. Follow _links.next to fetch all)", + "parameters": [ + { + "name": "pageLimit", + "schema": "integer", + "description": "How many records to return (must be between 1 and 250)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/blacklist", + "method": "create", + "httpMethod": "post", + "tag": "Blacklist", + "typeScriptTag": "blacklist", + "description": "Create an entry in blacklist", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/blacklist/{blackListId}", + "method": "delete", + "httpMethod": "delete", + "tag": "Blacklist", + "typeScriptTag": "blacklist", + "description": "Delete entry by id", + "parameters": [ + { + "name": "blackListId", + "schema": "string", + "required": true, + "description": "Id of the blacklist", + "example": "BLACKLISTID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/blacklist/{blackListId}", + "method": "get", + "httpMethod": "get", + "tag": "Blacklist", + "typeScriptTag": "blacklist", + "description": "Get entry by id", + "parameters": [ + { + "name": "blackListId", + "schema": "string", + "required": true, + "description": "Id of the blacklist", + "example": "BLACKLISTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/blacklist/ByNumber", + "method": "deleteByNumber", + "httpMethod": "delete", + "tag": "Blacklist", + "typeScriptTag": "blacklist", + "description": "Delete entry by number", + "parameters": [ + { + "name": "countryCode", + "schema": "string", + "description": "" + }, + { + "name": "phoneNumber", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/blacklist/ByNumber", + "method": "getByNumber", + "httpMethod": "get", + "tag": "Blacklist", + "typeScriptTag": "blacklist", + "description": "Get entry by number", + "parameters": [ + { + "name": "countryCode", + "schema": "string", + "description": "" + }, + { + "name": "phoneNumber", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/email/outgoing/sendusingtemplate", + "method": "sendUsingTemplate", + "httpMethod": "post", + "tag": "Email", + "typeScriptTag": "email", + "description": "Send an email using a template", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/email/outgoing", + "method": "send", + "httpMethod": "post", + "tag": "Email", + "typeScriptTag": "email", + "description": "Send an email", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/email/outgoing/events", + "method": "getEvents", + "httpMethod": "get", + "tag": "Email", + "typeScriptTag": "email", + "description": "Get email events", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "description": "How many events to return (must be between 1 and 250)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/email/templates", + "method": "getAllEmailTemplates", + "httpMethod": "get", + "tag": "Email Templates", + "typeScriptTag": "emailTemplates", + "description": "Get all email templates", + "parameters": [ + { + "name": "pageLimit", + "schema": "integer", + "description": "How many records to return (must be between 1 and 250)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/email/templates/{id}", + "method": "getEmailTemplate", + "httpMethod": "get", + "tag": "Email Templates", + "typeScriptTag": "emailTemplates", + "description": "Get email template by id", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/gdpr/deletionrequests", + "method": "deletionRequests", + "httpMethod": "post", + "tag": "Gdpr", + "typeScriptTag": "gdpr", + "description": "Create information Deletion Request", + "parameters": [ + { + "name": "numberInfo", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists", + "method": "getAllLists", + "httpMethod": "get", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Get all lists", + "parameters": [ + { + "name": "pageLimit", + "schema": "integer", + "description": "How many records to return (must be between 1 and 250)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists", + "method": "createList", + "httpMethod": "post", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Create list", + "parameters": [ + { + "name": "name", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}", + "method": "deleteList", + "httpMethod": "delete", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Delete list", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}", + "method": "getList", + "httpMethod": "get", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Get list", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}", + "method": "updateList", + "httpMethod": "put", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Update list", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "The id of the list", + "example": "LISTID" + }, + { + "name": "name", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}/recipients", + "method": "getAllRecipient", + "httpMethod": "get", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Get all recipients in a list", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + }, + { + "name": "pageLimit", + "schema": "integer", + "description": "How many records to return (must be between 1 and 250)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}/recipients", + "method": "createRecipient", + "httpMethod": "post", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Create recipient", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}/recipients/all", + "method": "deleteAllRecipients", + "httpMethod": "delete", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Deletes all recipients from a list", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "The affected count" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}/recipients/{recipientId}", + "method": "deleteRecipient", + "httpMethod": "delete", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Delete recipient by id", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + }, + { + "name": "recipientId", + "schema": "string", + "required": true, + "description": "Id of the recipient", + "example": "RECIPIENTID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}/recipients/{recipientId}", + "method": "getRecipient", + "httpMethod": "get", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Get recipient by id", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + }, + { + "name": "recipientId", + "schema": "string", + "required": true, + "description": "Id of the recipient", + "example": "RECIPIENTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}/recipients/{recipientId}", + "method": "updateRecipient", + "httpMethod": "put", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Update recipient", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + }, + { + "name": "recipientId", + "schema": "string", + "required": true, + "description": "", + "example": "RECIPIENTID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}/recipients/ByNumber", + "method": "deleteRecipientByNumber", + "httpMethod": "delete", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Delete recipient by number", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + }, + { + "name": "countryCode", + "schema": "string", + "description": "Target countryCode" + }, + { + "name": "phoneNumber", + "schema": "string", + "description": "Target phoneNumber" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}/recipients/ByNumber", + "method": "getRecipientByNumber", + "httpMethod": "get", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Get recipient by number", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + }, + { + "name": "countryCode", + "schema": "string", + "description": "Target countryCode" + }, + { + "name": "phoneNumber", + "schema": "string", + "description": "Target phoneNumber" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/lists/{listId}/recipients/ByNumber", + "method": "createOrUpdateRecipientByNumber", + "httpMethod": "post", + "tag": "Lists", + "typeScriptTag": "lists", + "description": "Create or update recipient by number", + "parameters": [ + { + "name": "listId", + "schema": "string", + "required": true, + "description": "Id of the list", + "example": "LISTID" + }, + { + "name": "countryCode", + "schema": "string", + "description": "Target countryCode" + }, + { + "name": "phoneNumber", + "schema": "string", + "description": "Target phoneNumber" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/incoming/messages", + "method": "getMessages", + "httpMethod": "get", + "tag": "Sms - Incoming", + "typeScriptTag": "smsIncoming", + "description": "Get incoming sms messages.", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "description": "How many records to return (must be between 1 and 250)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/outgoing", + "method": "create", + "httpMethod": "post", + "tag": "Sms - Outgoing", + "typeScriptTag": "smsOutgoing", + "description": "Send sms messages.", + "parameters": [ + { + "name": "messages", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/outgoing/sendusingquery", + "method": "sendUsingQueryGet", + "httpMethod": "get", + "tag": "Sms - Outgoing", + "typeScriptTag": "smsOutgoing", + "description": "Send sms messages using query parameters.", + "parameters": [ + { + "name": "text", + "schema": "string", + "description": "The text message.\nIf the max length is exceeded, the message text is truncated and sent.", + "example": "This is a message text to be sent" + }, + { + "name": "from", + "schema": "string", + "description": "The sender. This can either be a 3-11 chars text sender or an up to 14 digit long sender number.\nIf the max length is exceeded, the string is truncated.", + "example": "PetShop" + }, + { + "name": "flash", + "schema": "boolean", + "description": "If true, the message will be shown as a flash message (also known as a class0 message) on the target phone. If false, it will be received as a standard text message.\nDefault: false", + "example": false + }, + { + "name": "encoding", + "schema": "string", + "description": "The encoding of the message. Can be either \"gsm7\", \"ucs2\" or \"auto\".\n\"gsm7\" is the default alfabet for text messages and when using gsm7, a single sms message can contain 160 characters. If the length exceeeds 160 characters, the message is actually split up into parts of 153 characters and charged according to this. Please note, that a few, specific characters fill up 2 bytes and count for 2 letters. Ref: https://en.wikipedia.org/wiki/GSM_03.38\n\"ucs2\"\" allows for more non-roman characters to be used along with smileys. When using this encoding, a single message can consist of 70 characters. If the message exceeds 70 characters, the final message is actually split into parts of 67 characters.\n\"auto\" can be used in case the sender wishes to support non-roman characters but wants to save the expenses on all the trafic that only contains gsm characters anyway.\nDefault: \"gsm7\"", + "example": "gsm7" + }, + { + "name": "to", + "schema": "string", + "description": "The msisdn (country code and number) to send to. (Remember to include countrycode in all numbers, e.g. 4512345678).\nIf max length is exceeded, the entire api call will fail.", + "example": "4512345678" + }, + { + "name": "countryHint", + "schema": "string", + "description": "For optimal phone number validation, we encourage you to provide us with a country code. This can be the numeric country code (like 44) or the two-letter suffix (like GB). If this field is empty it is important that you add the country code (e.g 44) in front of the phone number in “to”.", + "example": "45" + }, + { + "name": "messageId", + "schema": "string", + "description": "An optional message id used to identify the message.\nIf no message id is provided, a new message id is generated and assigned to the message. This id must be unique across all messages created on the same account.\n(In case a previous message has been deleted according to GDPR deletion rules setup on the specific account, the messageId is allowed to be reused)\nIf max length is exceeded, the entire api call will fail.", + "example": "PetShop" + }, + { + "name": "respectBlacklist", + "schema": "boolean", + "description": "If true, this message will be blocked from sending if the target number is on the account's blacklist. If false, the message will be sent no matter blacklist settings.\nDefault: true", + "example": true + }, + { + "name": "validityPeriodInSeconds", + "schema": "integer", + "description": "The validity period in seconds. Minimum is 60 seconds and maximum is 172800 (48 hours).\nIf not specified, the messages is attempted to be delivered in 48 hours. A typical use of validityPeriod is for messages that makes no sense to delivery efter er certain time frame, in the case the phone is turned of, e.g. two factor codes.\nPlease note, that messages are still charged even though the operator is cancelling the delivery attempt due to an exceeded validity period.", + "example": 90 + }, + { + "name": "statusCallbackUrl", + "schema": "string", + "description": "In case you would like a callback from us when the message is delivered, you can specify it here and we will call it when we have new message statuses.\nThe callback payload will be an array of status objects.\nApi calls sending messages with the same apikey will be subject to being bulked together.", + "example": "https://[your_domain]/your/desired/path" + }, + { + "name": "sendTimeUtcTime", + "schema": "string", + "description": "" + }, + { + "name": "sendTimeLocalServerTime", + "schema": "string", + "description": "" + }, + { + "name": "msisdnCooldownInMinutes", + "schema": "integer", + "description": "If set, the message will be cancelled if the same mobile number already have received a SMS within this specified time period.\nFx. used to prevent spamming a mobile number.\nMinimum 60 minutes (1 hour) and maximum is 43200 minutes (30 days).", + "example": 1440 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/outgoing/sendusingquery", + "method": "sendUsingQueryPost", + "httpMethod": "post", + "tag": "Sms - Outgoing", + "typeScriptTag": "smsOutgoing", + "description": "Send sms messages using query parameters.", + "parameters": [ + { + "name": "text", + "schema": "string", + "description": "The text message.\nIf the max length is exceeded, the message text is truncated and sent.", + "example": "This is a message text to be sent" + }, + { + "name": "from", + "schema": "string", + "description": "The sender. This can either be a 3-11 chars text sender or an up to 14 digit long sender number.\nIf the max length is exceeded, the string is truncated.", + "example": "PetShop" + }, + { + "name": "flash", + "schema": "boolean", + "description": "If true, the message will be shown as a flash message (also known as a class0 message) on the target phone. If false, it will be received as a standard text message.\nDefault: false", + "example": false + }, + { + "name": "encoding", + "schema": "string", + "description": "The encoding of the message. Can be either \"gsm7\", \"ucs2\" or \"auto\".\n\"gsm7\" is the default alfabet for text messages and when using gsm7, a single sms message can contain 160 characters. If the length exceeeds 160 characters, the message is actually split up into parts of 153 characters and charged according to this. Please note, that a few, specific characters fill up 2 bytes and count for 2 letters. Ref: https://en.wikipedia.org/wiki/GSM_03.38\n\"ucs2\"\" allows for more non-roman characters to be used along with smileys. When using this encoding, a single message can consist of 70 characters. If the message exceeds 70 characters, the final message is actually split into parts of 67 characters.\n\"auto\" can be used in case the sender wishes to support non-roman characters but wants to save the expenses on all the trafic that only contains gsm characters anyway.\nDefault: \"gsm7\"", + "example": "gsm7" + }, + { + "name": "to", + "schema": "string", + "description": "The msisdn (country code and number) to send to. (Remember to include countrycode in all numbers, e.g. 4512345678).\nIf max length is exceeded, the entire api call will fail.", + "example": "4512345678" + }, + { + "name": "countryHint", + "schema": "string", + "description": "For optimal phone number validation, we encourage you to provide us with a country code. This can be the numeric country code (like 44) or the two-letter suffix (like GB). If this field is empty it is important that you add the country code (e.g 44) in front of the phone number in “to”.", + "example": "45" + }, + { + "name": "messageId", + "schema": "string", + "description": "An optional message id used to identify the message.\nIf no message id is provided, a new message id is generated and assigned to the message. This id must be unique across all messages created on the same account.\n(In case a previous message has been deleted according to GDPR deletion rules setup on the specific account, the messageId is allowed to be reused)\nIf max length is exceeded, the entire api call will fail.", + "example": "PetShop" + }, + { + "name": "respectBlacklist", + "schema": "boolean", + "description": "If true, this message will be blocked from sending if the target number is on the account's blacklist. If false, the message will be sent no matter blacklist settings.\nDefault: true", + "example": true + }, + { + "name": "validityPeriodInSeconds", + "schema": "integer", + "description": "The validity period in seconds. Minimum is 60 seconds and maximum is 172800 (48 hours).\nIf not specified, the messages is attempted to be delivered in 48 hours. A typical use of validityPeriod is for messages that makes no sense to delivery efter er certain time frame, in the case the phone is turned of, e.g. two factor codes.\nPlease note, that messages are still charged even though the operator is cancelling the delivery attempt due to an exceeded validity period.", + "example": 90 + }, + { + "name": "statusCallbackUrl", + "schema": "string", + "description": "In case you would like a callback from us when the message is delivered, you can specify it here and we will call it when we have new message statuses.\nThe callback payload will be an array of status objects.\nApi calls sending messages with the same apikey will be subject to being bulked together.", + "example": "https://[your_domain]/your/desired/path" + }, + { + "name": "sendTimeUtcTime", + "schema": "string", + "description": "" + }, + { + "name": "sendTimeLocalServerTime", + "schema": "string", + "description": "" + }, + { + "name": "msisdnCooldownInMinutes", + "schema": "integer", + "description": "If set, the message will be cancelled if the same mobile number already have received a SMS within this specified time period.\nFx. used to prevent spamming a mobile number.\nMinimum 60 minutes (1 hour) and maximum is 43200 minutes (30 days).", + "example": 1440 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/outgoing/sendusingtemplate", + "method": "sendUsingTemplate", + "httpMethod": "post", + "tag": "Sms - Outgoing", + "typeScriptTag": "smsOutgoing", + "description": "Send sms messages using a template.", + "parameters": [ + { + "name": "templateId", + "schema": "string", + "required": true, + "description": "", + "example": "ecdcb257-c1e9-4b44-8a4e-f05822372d82" + }, + { + "name": "messages", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/outgoing/cancel", + "method": "cancel", + "httpMethod": "post", + "tag": "Sms - Outgoing", + "typeScriptTag": "smsOutgoing", + "description": "Cancel sms messages", + "parameters": [ + { + "name": "messageIds", + "schema": "array", + "required": true, + "description": "", + "example": [ + "id1", + "id2" + ] + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/outgoing/reports", + "method": "getReports", + "httpMethod": "get", + "tag": "Sms - Outgoing", + "typeScriptTag": "smsOutgoing", + "description": "Get sms status reports.", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "description": "How many records to return (must be between 1 and 250)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/templates", + "method": "getAllTemplates", + "httpMethod": "get", + "tag": "Templates", + "typeScriptTag": "templates", + "description": "Get all templates", + "parameters": [ + { + "name": "pageLimit", + "schema": "integer", + "description": "How many records to return (must be between 1 and 250)" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/sms/templates/{id}", + "method": "getTemplate", + "httpMethod": "get", + "tag": "Templates", + "typeScriptTag": "templates", + "description": "Get template by id", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/v4/tools/parsephonenumbers", + "method": "parsePhoneNumbers", + "httpMethod": "post", + "tag": "Tools", + "typeScriptTag": "tools", + "description": "Parse phone numbers", + "parameters": [ + { + "name": "numbersToParse", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + } + ], + "repositoryDescription": "SMS-Gateway that handles 150M+ messages annually with 99.99% uptime. Easy communication for customers and employees. User-friendly gateway and API for seamless integration. inMobile's {language} SDK generated by Konfig (https://konfigthis.com/).", + "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/inmobile/logo.png", + "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/inmobile/openapi.yaml", + "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/inmobile/openapi.yaml", + "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/inmobile/imagePreview.png", + "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/inmobile/favicon.jpg", + "clientNameCamelCase": "inMobile", + "lastUpdated": "2024-03-29T22:11:39.095Z", + "typescriptSdkUsageCode": "import { InMobile } from 'in-mobile-typescript-sdk';\n\nconst inMobile = new InMobile({\n // Provide Basic Authentiation with an arbitrary username and your api key as password, e.g. some_value_to_be_ignored:your_api_key_here\n username: \"USERNAME\",\n password: \"PASSWORD\",\n // Specify your apikey in the url as https://api.inmobile.com/some/path?apikey=your_api_key_here. This method is only recommended if basic authorization is not possible.\n queryParameter: \"APIKEY\"\n})", + "typescriptSdkFirstRequestCode": "// Returns all blacklists (Paged result. Follow _links.next to fetch all)\nconst getAllResponse = inMobile.blacklist.getAll()", + "fixedSpecFileName": "in-mobile-fixed-spec.yaml" +} \ No newline at end of file diff --git a/sdks/db/published/from-custom-request_innoship.io.json b/sdks/db/published/from-custom-request_innoship.io.json new file mode 100644 index 0000000000..3a4dc22428 --- /dev/null +++ b/sdks/db/published/from-custom-request_innoship.io.json @@ -0,0 +1,2985 @@ +{ + "securitySchemes": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "X-Api-Key", + "in": "header" + } + }, + "apiBaseUrl": "https://api.innoship.com", + "apiVersion": "v1", + "apiDescription": "Api service implementation (version:6.0.1.503)", + "apiTitle": "Innoship API", + "endpoints": 46, + "sdkMethods": 51, + "schemas": 118, + "parameters": 330, + "contactEmail": "andrei@innoship.ro", + "originalCustomRequest": { + "type": "GET", + "url": "https://api.innoship.io/swagger/v1/swagger.json", + "apiBaseUrl": "https://api.innoship.com" + }, + "customRequestSpecFilename": "innoship.io.yaml", + "difficultyScore": 171, + "difficulty": "Medium", + "company": "Innoship", + "sdkName": "innoship-{language}-sdk", + "clientName": "Innoship", + "metaDescription": "Innoship is the advanced delivery management platform that helps retailers to improve customer experience by streamlining the delivery process. We combined our eCommerce logistics expertise with all the enterprise features you need to master last-mile customer experience. \n\nBacked by Abris Capital Partners, the ESG transformation specialist private equity investor, Innoship is now part of Alsendo group, the leading eCommerce shipping solutions technologies in the CEE region.\n\nFrom checkout and shipping to tracking, returns and analytics, Innoship helps you safely deliver on promises made to your customers. \n\nEffortless integration, hassle-free delivery\n•\tA simple, one-time integration with the Innoship app allows retailers to access any carrier, local or international.\n•\tExternal markets become readily available with seamless connections to hundreds of carriers in 15+ countries.", + "apiStatusUrls": "inherit", + "homepage": "innoship.io", + "developerDocumentation": "api.innoship.io/index.html", + "categories": [ + "shipping_api", + "logistics_provider", + "shipping_integration" + ], + "category": "eCommerce", + "methods": [ + { + "url": "/api/ClientLocation", + "method": "getDetail", + "httpMethod": "get", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "countryCode", + "schema": "string", + "description": "" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation", + "method": "createNew", + "httpMethod": "post", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "address", + "schema": "object", + "description": "" + }, + { + "name": "courierCutOffTimes", + "schema": "string", + "description": "" + }, + { + "name": "courierAutomaticCallTimes", + "schema": "string", + "description": "" + }, + { + "name": "useSameCourierForSameAddress", + "schema": "boolean", + "description": "" + }, + { + "name": "courierFailPolicy", + "schema": "integer", + "description": "" + }, + { + "name": "timeZoneId", + "schema": "string", + "description": "" + }, + { + "name": "priceGroupId", + "schema": "integer", + "description": "" + }, + { + "name": "notificationEmail", + "schema": "string", + "description": "" + }, + { + "name": "notificationPhone", + "schema": "string", + "description": "" + }, + { + "name": "courierVoucherService", + "schema": "object", + "description": "" + }, + { + "name": "marketPlaceCallBackSettings", + "schema": "object", + "description": "" + }, + { + "name": "importIsActive", + "schema": "boolean", + "description": "" + }, + { + "name": "setHandoverOnManifest", + "schema": "boolean", + "description": "" + }, + { + "name": "id", + "schema": "integer", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "externalLocationId", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation/{id}", + "method": "removeById", + "httpMethod": "delete", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "id", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation/{id}", + "method": "getById", + "httpMethod": "get", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "id", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation/{id}", + "method": "updateById", + "httpMethod": "put", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "id", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "address", + "schema": "object", + "description": "" + }, + { + "name": "courierCutOffTimes", + "schema": "string", + "description": "" + }, + { + "name": "courierAutomaticCallTimes", + "schema": "string", + "description": "" + }, + { + "name": "useSameCourierForSameAddress", + "schema": "boolean", + "description": "" + }, + { + "name": "courierFailPolicy", + "schema": "integer", + "description": "" + }, + { + "name": "timeZoneId", + "schema": "string", + "description": "" + }, + { + "name": "priceGroupId", + "schema": "integer", + "description": "" + }, + { + "name": "notificationEmail", + "schema": "string", + "description": "" + }, + { + "name": "notificationPhone", + "schema": "string", + "description": "" + }, + { + "name": "courierVoucherService", + "schema": "object", + "description": "" + }, + { + "name": "marketPlaceCallBackSettings", + "schema": "object", + "description": "" + }, + { + "name": "importIsActive", + "schema": "boolean", + "description": "" + }, + { + "name": "setHandoverOnManifest", + "schema": "boolean", + "description": "" + }, + { + "name": "id", + "schema": "integer", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "externalLocationId", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation/Summary", + "method": "createSummaryReport", + "httpMethod": "post", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "name", + "schema": "array", + "description": "" + }, + { + "name": "countryId", + "schema": "array", + "description": "" + }, + { + "name": "countyId", + "schema": "array", + "description": "" + }, + { + "name": "localityId", + "schema": "array", + "description": "" + }, + { + "name": "addressText", + "schema": "string", + "description": "" + }, + { + "name": "courierId", + "schema": "array", + "description": "" + }, + { + "name": "ids", + "schema": "array", + "description": "" + }, + { + "name": "createdAtLe", + "schema": "string", + "description": "" + }, + { + "name": "createdAtGe", + "schema": "string", + "description": "" + }, + { + "name": "userId", + "schema": "array", + "description": "" + }, + { + "name": "skip", + "schema": "integer", + "description": "" + }, + { + "name": "take", + "schema": "integer", + "description": "" + }, + { + "name": "orderBy", + "schema": "string", + "description": "" + }, + { + "name": "orderByAsc", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation/Validate", + "method": "validateLocationDetails", + "httpMethod": "post", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "address", + "schema": "object", + "description": "" + }, + { + "name": "courierCutOffTimes", + "schema": "string", + "description": "" + }, + { + "name": "courierAutomaticCallTimes", + "schema": "string", + "description": "" + }, + { + "name": "useSameCourierForSameAddress", + "schema": "boolean", + "description": "" + }, + { + "name": "courierFailPolicy", + "schema": "integer", + "description": "" + }, + { + "name": "timeZoneId", + "schema": "string", + "description": "" + }, + { + "name": "priceGroupId", + "schema": "integer", + "description": "" + }, + { + "name": "notificationEmail", + "schema": "string", + "description": "" + }, + { + "name": "notificationPhone", + "schema": "string", + "description": "" + }, + { + "name": "courierVoucherService", + "schema": "object", + "description": "" + }, + { + "name": "marketPlaceCallBackSettings", + "schema": "object", + "description": "" + }, + { + "name": "importIsActive", + "schema": "boolean", + "description": "" + }, + { + "name": "setHandoverOnManifest", + "schema": "boolean", + "description": "" + }, + { + "name": "courierServices", + "schema": "array", + "description": "" + }, + { + "name": "id", + "schema": "integer", + "description": "" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "externalLocationId", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation/{locationId}/Courier", + "method": "createCourier", + "httpMethod": "post", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "locationId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "courierId", + "schema": "integer", + "description": "" + }, + { + "name": "isEmagMarketPlace", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation/{locationId}/Courier/{courierId}", + "method": "removeCourierById", + "httpMethod": "delete", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "locationId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "courierId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "force", + "schema": "boolean", + "description": "" + }, + { + "name": "isEmagMarketPlace", + "schema": "boolean", + "description": "" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation/{locationId}/CourierServices", + "method": "updateCourierServices", + "httpMethod": "patch", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "locationId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "applyToAllLocations", + "schema": "boolean", + "description": "" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/ClientLocation/{locationId}/CourierServices", + "method": "updateCourierServices", + "httpMethod": "put", + "tag": "ClientLocation", + "typeScriptTag": "clientLocation", + "description": "", + "parameters": [ + { + "name": "locationId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "applyToAllLocations", + "schema": "boolean", + "description": "" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/Courier/RequestPickup", + "method": "requestPickup", + "httpMethod": "post", + "tag": "Courier", + "typeScriptTag": "courier", + "description": "Request pickup to courier", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "courierId", + "schema": "integer", + "description": "" + }, + { + "name": "locationId", + "schema": "integer", + "description": "" + }, + { + "name": "lastPickupHour", + "schema": "integer", + "description": "" + }, + { + "name": "lastPickMinute", + "schema": "integer", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Courier/All", + "method": "getAll", + "httpMethod": "get", + "tag": "Courier", + "typeScriptTag": "courier", + "description": "Get all couriers", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Feedback/{from}/{to}", + "method": "getBetweenDates", + "httpMethod": "get", + "tag": "Feedback", + "typeScriptTag": "feedback", + "description": "", + "parameters": [ + { + "name": "from", + "schema": "string", + "required": true, + "description": "", + "example": "FROM" + }, + { + "name": "to", + "schema": "string", + "required": true, + "description": "", + "example": "TO" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/Label/by-courier/{courierId}/awb/{awb}", + "method": "getByCourierAwb", + "httpMethod": "get", + "tag": "Label", + "typeScriptTag": "label", + "description": "Gets the label for the specified courier awb number", + "parameters": [ + { + "name": "courierId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "awb", + "schema": "string", + "required": true, + "description": "", + "example": "AWB" + }, + { + "name": "type", + "schema": "string", + "description": "", + "default": "PDF" + }, + { + "name": "format", + "schema": "string", + "description": "", + "default": "A6" + }, + { + "name": "includeVoucher", + "schema": "boolean", + "description": "", + "default": false + }, + { + "name": "useFile", + "schema": "boolean", + "description": "", + "default": true + }, + { + "name": "skipCache", + "schema": "boolean", + "description": "", + "default": false + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Label/by-courier/{courierId}/voucher/{awb}", + "method": "getVoucherByCourierAwb", + "httpMethod": "get", + "tag": "Label", + "typeScriptTag": "label", + "description": "Gets the voucher label for the specified courier awb number", + "parameters": [ + { + "name": "courierId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "awb", + "schema": "string", + "required": true, + "description": "", + "example": "AWB" + }, + { + "name": "type", + "schema": "string", + "description": "", + "default": "PDF" + }, + { + "name": "format", + "schema": "string", + "description": "", + "default": "A6" + }, + { + "name": "useFile", + "schema": "boolean", + "description": "", + "default": true + }, + { + "name": "skipCache", + "schema": "boolean", + "description": "", + "default": false + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Label/by-courier/{courierId}/awb/{awb}/parcel/{barcodes}", + "method": "getByAwbAndParcel", + "httpMethod": "get", + "tag": "Label", + "typeScriptTag": "label", + "description": "Gets the label for the specified courier parcel barcode and order awb", + "parameters": [ + { + "name": "courierId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "awb", + "schema": "string", + "required": true, + "description": "", + "example": "AWB" + }, + { + "name": "barcodes", + "schema": "string", + "required": true, + "description": "", + "example": "BARCODES" + }, + { + "name": "type", + "schema": "string", + "description": "", + "default": "PDF" + }, + { + "name": "format", + "schema": "string", + "description": "", + "default": "A6" + }, + { + "name": "useFile", + "schema": "boolean", + "description": "", + "default": true + }, + { + "name": "skipCache", + "schema": "boolean", + "description": "", + "default": false + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Label/bulk", + "method": "createBulk", + "httpMethod": "post", + "tag": "Label", + "typeScriptTag": "label", + "description": "Create bulk labels operation", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "labelType", + "schema": "string", + "description": "" + }, + { + "name": "labelFormat", + "schema": "string", + "description": "" + }, + { + "name": "useFile", + "schema": "boolean", + "description": "" + }, + { + "name": "includeVoucher", + "schema": "boolean", + "description": "" + }, + { + "name": "awBs", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Returns OperationId" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Label/bulk/{operationId}", + "method": "getBulkByOperationId", + "httpMethod": "get", + "tag": "Label", + "typeScriptTag": "label", + "description": "Get bulk labels by operationId", + "parameters": [ + { + "name": "operationId", + "schema": "string", + "required": true, + "description": "", + "example": "OPERATIONID" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Location/ClientLocations", + "method": "getClientLocations", + "httpMethod": "get", + "tag": "Location", + "typeScriptTag": "location", + "description": "", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/Location/FixedLocation/{id}", + "method": "getFixedLocationById", + "httpMethod": "get", + "tag": "Location", + "typeScriptTag": "location", + "description": "", + "parameters": [ + { + "name": "id", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/Location/FixedLocations", + "method": "getFixedLocations", + "httpMethod": "get", + "tag": "Location", + "typeScriptTag": "location", + "description": "", + "parameters": [ + { + "name": "courier", + "schema": "string", + "description": "" + }, + { + "name": "countryCode", + "schema": "string", + "description": "" + }, + { + "name": "countyName", + "schema": "string", + "description": "" + }, + { + "name": "localityName", + "schema": "string", + "description": "" + }, + { + "name": "fixedLocationType", + "schema": "string", + "description": "" + }, + { + "name": "showInactive", + "schema": "boolean", + "description": "" + }, + { + "name": "restrictionParcelsCount", + "schema": "integer", + "description": "" + }, + { + "name": "restrictionSizeHeight", + "schema": "integer", + "description": "" + }, + { + "name": "restrictionSizeWidth", + "schema": "integer", + "description": "" + }, + { + "name": "restrictionSizeLength", + "schema": "integer", + "description": "" + }, + { + "name": "externalLocationId", + "schema": "string", + "description": "" + }, + { + "name": "latitude", + "schema": "number", + "description": "" + }, + { + "name": "longitude", + "schema": "number", + "description": "" + }, + { + "name": "radius", + "schema": "number", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/Location/Countries", + "method": "getCountryList", + "httpMethod": "get", + "tag": "Location", + "typeScriptTag": "location", + "description": "", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/Location/Counties/{countryCode}", + "method": "getCountiesByCountryCode", + "httpMethod": "get", + "tag": "Location", + "typeScriptTag": "location", + "description": "", + "parameters": [ + { + "name": "countryCode", + "schema": "string", + "required": true, + "description": "", + "example": "COUNTRYCODE" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/Location/Localities/{countyId}", + "method": "getLocalitiesByCountyId", + "httpMethod": "get", + "tag": "Location", + "typeScriptTag": "location", + "description": "", + "parameters": [ + { + "name": "countyId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/Location/Postalcodes/{CountryCode}/{PostalCode}", + "method": "getPostalCodeDetails", + "httpMethod": "get", + "tag": "Location", + "typeScriptTag": "location", + "description": "", + "parameters": [ + { + "name": "countryCode", + "schema": "string", + "required": true, + "description": "", + "example": "COUNTRYCODE" + }, + { + "name": "postalCode", + "schema": "string", + "required": true, + "description": "", + "example": "POSTALCODE" + }, + { + "name": "courierId", + "schema": "integer", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/api/Location/Postalcodes/{LocalityId}", + "method": "getPostalcodesByLocalityId", + "httpMethod": "get", + "tag": "Location", + "typeScriptTag": "location", + "description": "", + "parameters": [ + { + "name": "localityId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "courierId", + "schema": "integer", + "description": "" + }, + { + "name": "filter", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/api/Location/Postalcodes/Country/{CountryCode}", + "method": "getPostalCodesByCountry", + "httpMethod": "get", + "tag": "Location", + "typeScriptTag": "location", + "description": "", + "parameters": [ + { + "name": "countryCode", + "schema": "string", + "required": true, + "description": "", + "example": "COUNTRYCODE" + }, + { + "name": "courierId", + "schema": "integer", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/api/Manifest", + "method": "reportById", + "httpMethod": "get", + "tag": "Manifest", + "typeScriptTag": "manifest", + "description": "Requests manifest report by id", + "parameters": [ + { + "name": "manifestId", + "schema": "integer", + "description": "" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Returns PDF" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Manifest", + "method": "requestPickupAndManifestId", + "httpMethod": "post", + "tag": "Manifest", + "typeScriptTag": "manifest", + "description": "Requests pickup and get manifest id", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "courierId", + "schema": "string", + "description": "" + }, + { + "name": "externalLocationId", + "schema": "string", + "description": "" + }, + { + "name": "lastPickHour", + "schema": "integer", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Returns ManifestId" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Notifications/sendsms", + "method": "sendSmsNotification", + "httpMethod": "post", + "tag": "Notifications", + "typeScriptTag": "notifications", + "description": "", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "campaignName", + "schema": "string", + "description": "" + }, + { + "name": "data", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Success" + } + ] + }, + { + "url": "/api/OfflineOrder/Activate", + "method": "activateOrder", + "httpMethod": "put", + "tag": "OfflineOrder", + "typeScriptTag": "offlineOrder", + "description": "Activate Offline Orders", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Activated successfully" + }, + { + "statusCode": "400", + "description": "Unable to process due to validation errors" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/OfflineOrder/Edit", + "method": "updateOrderDetails", + "httpMethod": "put", + "tag": "OfflineOrder", + "typeScriptTag": "offlineOrder", + "description": "Edit Offline Orders", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Activated successfully" + }, + { + "statusCode": "400", + "description": "Unable to process due to validation errors" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/OfflineOrder/Add", + "method": "addOrder", + "httpMethod": "post", + "tag": "OfflineOrder", + "typeScriptTag": "offlineOrder", + "description": "Add Offline Orders", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Added successfully" + }, + { + "statusCode": "400", + "description": "Unable to process due to validation errors" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Order", + "method": "createNewOrder", + "httpMethod": "post", + "tag": "Order", + "typeScriptTag": "order", + "description": "Creates a new order", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "parameters", + "schema": "object", + "description": "" + }, + { + "name": "serviceId", + "schema": "integer", + "description": "" + }, + { + "name": "courierId", + "schema": "string", + "description": "" + }, + { + "name": "shipmentDate", + "schema": "string", + "description": "" + }, + { + "name": "shipmentDateEnd", + "schema": "string", + "description": "" + }, + { + "name": "addressFrom", + "schema": "object", + "description": "" + }, + { + "name": "addressTo", + "schema": "object", + "description": "" + }, + { + "name": "addressReturn", + "schema": "object", + "description": "" + }, + { + "name": "payment", + "schema": "string", + "description": "" + }, + { + "name": "content", + "schema": "object", + "description": "" + }, + { + "name": "extra", + "schema": "object", + "description": "" + }, + { + "name": "externalClientLocation", + "schema": "string", + "description": "" + }, + { + "name": "externalOrderId", + "schema": "string", + "description": "" + }, + { + "name": "metadata", + "schema": "string", + "description": "" + }, + { + "name": "sourceChannel", + "schema": "string", + "description": "" + }, + { + "name": "observation", + "schema": "string", + "description": "" + }, + { + "name": "customAttributes", + "schema": "object", + "description": "" + }, + { + "name": "clientSettings", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/simulate", + "method": "simulateOrder", + "httpMethod": "post", + "tag": "Order", + "typeScriptTag": "order", + "description": "", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "parameters", + "schema": "object", + "description": "" + }, + { + "name": "serviceId", + "schema": "integer", + "description": "" + }, + { + "name": "courierId", + "schema": "string", + "description": "" + }, + { + "name": "shipmentDate", + "schema": "string", + "description": "" + }, + { + "name": "shipmentDateEnd", + "schema": "string", + "description": "" + }, + { + "name": "addressFrom", + "schema": "object", + "description": "" + }, + { + "name": "addressTo", + "schema": "object", + "description": "" + }, + { + "name": "addressReturn", + "schema": "object", + "description": "" + }, + { + "name": "payment", + "schema": "string", + "description": "" + }, + { + "name": "content", + "schema": "object", + "description": "" + }, + { + "name": "extra", + "schema": "object", + "description": "" + }, + { + "name": "externalClientLocation", + "schema": "string", + "description": "" + }, + { + "name": "externalOrderId", + "schema": "string", + "description": "" + }, + { + "name": "metadata", + "schema": "string", + "description": "" + }, + { + "name": "sourceChannel", + "schema": "string", + "description": "" + }, + { + "name": "observation", + "schema": "string", + "description": "" + }, + { + "name": "customAttributes", + "schema": "object", + "description": "" + }, + { + "name": "clientSettings", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/validate", + "method": "validateNewOrder", + "httpMethod": "post", + "tag": "Order", + "typeScriptTag": "order", + "description": "Validates a new order request", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "parameters", + "schema": "object", + "description": "" + }, + { + "name": "serviceId", + "schema": "integer", + "description": "" + }, + { + "name": "courierId", + "schema": "string", + "description": "" + }, + { + "name": "shipmentDate", + "schema": "string", + "description": "" + }, + { + "name": "shipmentDateEnd", + "schema": "string", + "description": "" + }, + { + "name": "addressFrom", + "schema": "object", + "description": "" + }, + { + "name": "addressTo", + "schema": "object", + "description": "" + }, + { + "name": "addressReturn", + "schema": "object", + "description": "" + }, + { + "name": "payment", + "schema": "string", + "description": "" + }, + { + "name": "content", + "schema": "object", + "description": "" + }, + { + "name": "extra", + "schema": "object", + "description": "" + }, + { + "name": "externalClientLocation", + "schema": "string", + "description": "" + }, + { + "name": "externalOrderId", + "schema": "string", + "description": "" + }, + { + "name": "metadata", + "schema": "string", + "description": "" + }, + { + "name": "sourceChannel", + "schema": "string", + "description": "" + }, + { + "name": "observation", + "schema": "string", + "description": "" + }, + { + "name": "customAttributes", + "schema": "object", + "description": "" + }, + { + "name": "clientSettings", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "201", + "description": "Creates an new order in the system" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/multiple/simulate", + "method": "simulateMultiple", + "httpMethod": "post", + "tag": "Order", + "typeScriptTag": "order", + "description": "", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/file", + "method": "uploadFile", + "httpMethod": "post", + "tag": "Order", + "typeScriptTag": "order", + "description": "", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/{courierId}/awb/{awbNo}", + "method": "deleteExistingOrder", + "httpMethod": "delete", + "tag": "Order", + "typeScriptTag": "order", + "description": "Deletes an existing order", + "parameters": [ + { + "name": "courierId", + "schema": "integer", + "required": true, + "description": "Courier id", + "example": 0 + }, + { + "name": "awbNo", + "schema": "string", + "required": true, + "description": "AWB number", + "example": "AWBNO" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/UpdateStatus", + "method": "updateStatus", + "httpMethod": "post", + "tag": "Order", + "typeScriptTag": "order", + "description": "Updates orders statuses", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Request was processed successfully" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/UpdateParcels", + "method": "updateParcels", + "httpMethod": "post", + "tag": "Order", + "typeScriptTag": "order", + "description": "Create a new order based on the existing one and cancel the original", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "parameters", + "schema": "object", + "description": "" + }, + { + "name": "courierId", + "schema": "string", + "description": "" + }, + { + "name": "courierShipmentId", + "schema": "string", + "description": "" + }, + { + "name": "envelopeCount", + "schema": "integer", + "description": "" + }, + { + "name": "parcelsCount", + "schema": "integer", + "description": "" + }, + { + "name": "palettesCount", + "schema": "integer", + "description": "" + }, + { + "name": "oversizedPackage", + "schema": "boolean", + "description": "" + }, + { + "name": "totalWeight", + "schema": "number", + "description": "" + }, + { + "name": "parcels", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Creates an new order in the system" + }, + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/UpdateCustomAttributes/{courierId}/awb/{awb}", + "method": "updateCustomAttributes", + "httpMethod": "post", + "tag": "Order", + "typeScriptTag": "order", + "description": "Updates custom attributes", + "parameters": [ + { + "name": "courierId", + "schema": "integer", + "required": true, + "description": "Courier id", + "example": 0 + }, + { + "name": "awb", + "schema": "string", + "required": true, + "description": "AWB number", + "example": "AWB" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Request was processed successfully" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/by-location/{externalLocationId}/{from}/{to}", + "method": "getByLocationDates", + "httpMethod": "get", + "tag": "Order", + "typeScriptTag": "order", + "description": "Retrieve orders by externalLocationId with dates filter", + "parameters": [ + { + "name": "externalLocationId", + "schema": "string", + "required": true, + "description": "External Location Id", + "example": "EXTERNALLOCATIONID" + }, + { + "name": "from", + "schema": "string", + "required": true, + "description": "From date", + "example": "FROM" + }, + { + "name": "to", + "schema": "string", + "required": true, + "description": "To date", + "example": "TO" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Request was processed successfully" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Order/ReturnAwbInfo/{courierId}/{returnAwb}", + "method": "getReturnAwbInfo", + "httpMethod": "get", + "tag": "Order", + "typeScriptTag": "order", + "description": "", + "parameters": [ + { + "name": "courierId", + "schema": "integer", + "required": true, + "description": "", + "example": 0 + }, + { + "name": "returnAwb", + "schema": "string", + "required": true, + "description": "", + "example": "RETURNAWB" + }, + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "" + } + ] + }, + { + "url": "/api/Order/UploadDocuments", + "method": "uploadDocuments", + "httpMethod": "post", + "tag": "Order", + "typeScriptTag": "order", + "description": "UploadDocuments", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "courierId", + "schema": "string", + "description": "" + }, + { + "name": "courierShipmentId", + "schema": "string", + "description": "" + }, + { + "name": "attachments", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Price", + "method": "getPrices", + "httpMethod": "post", + "tag": "Price", + "typeScriptTag": "price", + "description": "Gets the prices for the specified request", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "parameters", + "schema": "object", + "description": "" + }, + { + "name": "serviceId", + "schema": "integer", + "description": "" + }, + { + "name": "courierId", + "schema": "string", + "description": "" + }, + { + "name": "shipmentDate", + "schema": "string", + "description": "" + }, + { + "name": "shipmentDateEnd", + "schema": "string", + "description": "" + }, + { + "name": "addressFrom", + "schema": "object", + "description": "" + }, + { + "name": "addressTo", + "schema": "object", + "description": "" + }, + { + "name": "addressReturn", + "schema": "object", + "description": "" + }, + { + "name": "payment", + "schema": "string", + "description": "" + }, + { + "name": "content", + "schema": "object", + "description": "" + }, + { + "name": "extra", + "schema": "object", + "description": "" + }, + { + "name": "externalClientLocation", + "schema": "string", + "description": "" + }, + { + "name": "externalOrderId", + "schema": "string", + "description": "" + }, + { + "name": "metadata", + "schema": "string", + "description": "" + }, + { + "name": "sourceChannel", + "schema": "string", + "description": "" + }, + { + "name": "observation", + "schema": "string", + "description": "" + }, + { + "name": "customAttributes", + "schema": "object", + "description": "" + }, + { + "name": "clientSettings", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + } + ] + }, + { + "url": "/api/Track/by-awb/with-return", + "method": "orderCourierAwbWithReturn", + "httpMethod": "post", + "tag": "Track", + "typeScriptTag": "track", + "description": "Track by Order Courier AWB with return info", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "courier", + "schema": "string", + "description": "" + }, + { + "name": "awbList", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + } + ] + }, + { + "url": "/api/Track/return/by-awb", + "method": "byAwb", + "httpMethod": "post", + "tag": "Track", + "typeScriptTag": "track", + "description": "Track Retrun by Courier AWB", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "courier", + "schema": "string", + "description": "" + }, + { + "name": "awbList", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + } + ] + }, + { + "url": "/api/Voucher/Create", + "method": "generateNewVoucher", + "httpMethod": "post", + "tag": "Voucher", + "typeScriptTag": "voucher", + "description": "Create Voucher", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "courier", + "schema": "string", + "description": "" + }, + { + "name": "courierShipmentId", + "schema": "string", + "description": "" + }, + { + "name": "voucherCourier", + "schema": "string", + "description": "" + }, + { + "name": "insuranceAmount", + "schema": "number", + "description": "" + }, + { + "name": "insuranceCurrency", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Activated successfully" + }, + { + "statusCode": "400", + "description": "Unable to process due to validation errors" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + }, + { + "url": "/api/Voucher/Activate", + "method": "activateVoucher", + "httpMethod": "post", + "tag": "Voucher", + "typeScriptTag": "voucher", + "description": "Activate Voucher", + "parameters": [ + { + "name": "apiVersion", + "schema": "string", + "required": true, + "description": "The requested API version", + "example": "API-VERSION", + "default": "1.0" + }, + { + "name": "apiVersion", + "schema": "string", + "description": "The requested API version", + "default": "1.0" + }, + { + "name": "courier", + "schema": "string", + "description": "" + }, + { + "name": "courierShipmentId", + "schema": "string", + "description": "" + }, + { + "name": "courierShipmentVoucher", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Activated successfully" + }, + { + "statusCode": "400", + "description": "Unable to process due to validation errors" + }, + { + "statusCode": "401", + "description": "Unable to authorize request" + } + ] + } + ], + "repositoryDescription": "Innoship offers an advanced delivery management platform for retailers, combining eCommerce logistics expertise with enterprise features to optimize last-mile customer experience. Backed by Abris Capital Partners, now part of Alsendo group, it provides effortless integration with diverse carriers for seamless global shipping.", + "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/innoship/logo.png", + "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/innoship/openapi.yaml", + "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/innoship/openapi.yaml", + "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/innoship/imagePreview.jpg", + "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/innoship/favicon.png", + "clientNameCamelCase": "innoship", + "lastUpdated": "2024-03-29T22:11:39.095Z", + "typescriptSdkUsageCode": "import { Innoship } from 'innoship-typescript-sdk';\n\nconst innoship = new Innoship({\n apiKeyAuth: \"X_API_KEY\"\n})", + "typescriptSdkFirstRequestCode": "// \nconst getDetailResponse = innoship.clientLocation.getDetail({\n apiVersion: \"API-VERSION\"\n apiVersion: \"1.0\"\n})", + "fixedSpecFileName": "innoship-fixed-spec.yaml" +} \ No newline at end of file diff --git a/sdks/db/published/from-custom-request_lucca-hr.com_Figgo.json b/sdks/db/published/from-custom-request_lucca-hr.com_Figgo.json index c3840e57db..d467e2c308 100644 --- a/sdks/db/published/from-custom-request_lucca-hr.com_Figgo.json +++ b/sdks/db/published/from-custom-request_lucca-hr.com_Figgo.json @@ -23,7 +23,7 @@ }, "customRequestSpecFilename": "lucca-hr.com_Figgo.yaml", "difficultyScore": 37.75, - "difficulty": "Easy", + "difficulty": "Very Easy", "company": "Lucca", "serviceName": "Timmi Absences", "sdkName": "lucca-timmi-absences-{language}-sdk", @@ -256,7 +256,7 @@ "httpMethod": "post", "tag": "Imports", "typeScriptTag": "imports", - "description": "Import entitlements (deprecated)", + "description": "Import entitlements (https://developers.lucca.fr/", "parameters": [ { "name": "strict", @@ -342,7 +342,7 @@ "httpMethod": "post", "tag": "Imports", "typeScriptTag": "imports", - "description": "Replace entitlements (deprecated)", + "description": "Replace entitlements (https://developers.lucca.fr/", "parameters": [ { "name": "strict", @@ -440,7 +440,7 @@ "httpMethod": "post", "tag": "Imports", "typeScriptTag": "imports", - "description": "Import leaves (deprecated)", + "description": "Import leaves (https://developers.lucca.fr/", "parameters": [ { "name": "type", @@ -556,7 +556,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/lucca/timmi-absences/imagePreview.jpg", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/lucca/timmi-absences/favicon.png", "clientNameCamelCase": "luccaTimmiAbsences", - "lastUpdated": "2024-03-26T19:55:14.920Z", + "lastUpdated": "2024-03-29T22:11:39.095Z", "typescriptSdkUsageCode": "import { LuccaTimmiAbsences } from 'lucca-timmi-absences-typescript-sdk';\n\nconst luccaTimmiAbsences = new LuccaTimmiAbsences({\n // Header value must be equal to `lucca application={yourApiKey}`\n authorization: \"AUTHORIZATION\"\n})", "typescriptSdkFirstRequestCode": "// List leaves\nconst getApprovedListResponse = luccaTimmiAbsences.leaves.getApprovedList({\n paging: \"100,0\"\n date: \"DATE\"\n})", "fixedSpecFileName": "lucca-timmi-absences-fixed-spec.yaml" diff --git a/sdks/db/published/from-custom-request_measureone.com.json b/sdks/db/published/from-custom-request_measureone.com.json index 2ebf141377..9350398291 100644 --- a/sdks/db/published/from-custom-request_measureone.com.json +++ b/sdks/db/published/from-custom-request_measureone.com.json @@ -37,7 +37,7 @@ }, "customRequestSpecFilename": "measureone.com.yaml", "difficultyScore": 118.75, - "difficulty": "Medium", + "difficulty": "Easy", "company": "MeasureOne", "sdkName": "measure-one-{language}-sdk", "clientName": "MeasureOne", @@ -2553,7 +2553,7 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/measureone/imagePreview.jpg", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/measureone/favicon.png", "clientNameCamelCase": "measureOne", - "lastUpdated": "2024-03-29T19:11:15.684Z", + "lastUpdated": "2024-03-29T22:11:39.095Z", "typescriptSdkUsageCode": "import { MeasureOne } from 'measure-one-typescript-sdk';\n\nconst measureOne = new MeasureOne({\n // Enter the token with the `Bearer: ` prefix, e.g. \"Bearer \\<\\