diff --git a/openapi/billing_subscriptions_v1.json b/openapi/billing_subscriptions_v1.json index 5a8849a..f531b5c 100644 --- a/openapi/billing_subscriptions_v1.json +++ b/openapi/billing_subscriptions_v1.json @@ -3,7 +3,7 @@ "info": { "title": "Subscriptions", "description": "You can use billing plans and subscriptions to create subscriptions that process recurring PayPal payments for physical or digital goods, or services. A plan includes pricing and billing cycle information that defines the amount and frequency of charge for a subscription. You can also define a fixed plan, such as a $5 basic plan or a volume- or graduated-based plan with pricing tiers based on the quantity purchased. For more information, see Subscriptions Overview.", - "version": "1.8", + "version": "1.9", "contact": {} }, "servers": [ @@ -1279,6 +1279,9 @@ }, { "$ref": "#/components/parameters/paypal_request_id" + }, + { + "$ref": "#/components/parameters/paypal_client_metadata_id" } ], "requestBody": { @@ -1341,6 +1344,122 @@ } ], "tags": ["subscriptions"] + }, + "get": { + "summary": "List subscriptions", + "description": "List all subscriptions for merchant account.", + "operationId": "subscriptions.list", + "responses": { + "200": { + "description": "A successful request returns the HTTP `200 OK` status code and a JSON response body that lists the subscriptions.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/subscription_collection" + } + } + } + }, + "400": { + "description": "Request is not well-formed, syntactically incorrect, or violates schema.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/error_400" + }, + { + "$ref": "#/components/schemas/subscriptions.list-400" + } + ] + } + } + } + }, + "401": { + "description": "Authentication failed due to missing authorization header, or invalid authentication credentials.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/error_401" + }, + { + "$ref": "#/components/schemas/401" + } + ] + } + } + } + }, + "403": { + "description": "Authorization failed due to insufficient permissions.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/error_403" + }, + { + "$ref": "#/components/schemas/403" + } + ] + } + } + } + }, + "500": { + "description": "An internal server error has occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error_500" + } + } + } + }, + "default": { + "$ref": "#/components/responses/default" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/plan_ids" + }, + { + "$ref": "#/components/parameters/statuses" + }, + { + "$ref": "#/components/parameters/created_after" + }, + { + "$ref": "#/components/parameters/created_before" + }, + { + "$ref": "#/components/parameters/status_updated_before" + }, + { + "$ref": "#/components/parameters/status_updated_after" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/page_size" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "security": [ + { + "Oauth2": ["https://uri.paypal.com/services/subscriptions"] + } + ], + "tags": ["subscriptions"] } }, "/v1/billing/subscriptions/{id}": { @@ -2495,7 +2614,8 @@ "clientCredentials": { "tokenUrl": "/v1/oauth2/token", "scopes": { - "https://uri.paypal.com/services/subscriptions": "Manage plan & subscription" + "https://uri.paypal.com/services/subscriptions": "Manage plan & subscription", + "https://uri.paypal.com/services/subscriptions/confirm-payment": "Confirm Payment Source for a subscription" } } } @@ -2648,6 +2768,19 @@ } } }, + { + "title": "CURRENCY_NOT_SUPPORTED", + "properties": { + "issue": { + "type": "string", + "enum": ["CURRENCY_NOT_SUPPORTED"] + }, + "description": { + "type": "string", + "enum": ["Currency is not supported."] + } + } + }, { "title": "MULTIPLE_FREE_TRIAL_BILLING_CYCLES_NOT_SUPPORTED", "properties": { @@ -2957,11 +3090,13 @@ "description": "The label that overrides the business name in the PayPal account on the PayPal site.", "minLength": 1, "maxLength": 127, - "pattern": "^.*$" + "pattern": "^.*$", + "deprecated": true }, "locale": { "description": "The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`.", - "$ref": "#/components/schemas/language" + "$ref": "#/components/schemas/language", + "deprecated": true }, "shipping_preference": { "type": "string", @@ -2985,6 +3120,7 @@ "description": "Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages." } ], + "deprecated": true, "enum": ["GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"] }, "user_action": { @@ -3005,10 +3141,12 @@ "description": "After you redirect the customer to the PayPal subscription consent page, a Subscribe Now button appears. Use this option when you want PayPal to activate the subscription." } ], + "deprecated": true, "enum": ["CONTINUE", "SUBSCRIBE_NOW"] }, "payment_method": { "description": "The customer and merchant payment preferences.", + "deprecated": true, "type": "object", "title": "Payment Method", "properties": { @@ -3022,14 +3160,16 @@ "format": "uri", "description": "The URL where the customer is redirected after the customer approves the payment.", "minLength": 10, - "maxLength": 4000 + "maxLength": 4000, + "deprecated": true }, "cancel_url": { "type": "string", "format": "uri", "description": "The URL where the customer is redirected after the customer cancels the payment.", "minLength": 10, - "maxLength": 4000 + "maxLength": 4000, + "deprecated": true } }, "required": ["return_url", "cancel_url"] @@ -3169,7 +3309,7 @@ "description": "Additional attributes associated with the use of this card.", "properties": { "customer": { - "$ref": "#/components/schemas/customer" + "$ref": "#/components/schemas/card_customer" }, "vault": { "description": "Instruction to vault the card based on the specified strategy.", @@ -3187,7 +3327,7 @@ "description": "Additional attributes associated with the use of this card.", "properties": { "vault": { - "$ref": "#/components/schemas/vault_response" + "$ref": "#/components/schemas/card_vault_response" } } }, @@ -3205,7 +3345,7 @@ }, { "value": "MASTERCARD", - "description": "Mastecard card." + "description": "Mastercard card." }, { "value": "DISCOVER", @@ -3291,6 +3431,10 @@ "value": "SYNCHRONY", "description": "The Synchrony Financial (SYF) payment network." }, + { + "value": "EFTPOS", + "description": "The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network." + }, { "value": "UNKNOWN", "description": "UNKNOWN payment network." @@ -3320,6 +3464,7 @@ "RUPAY", "GE", "SYNCHRONY", + "EFTPOS", "UNKNOWN" ] }, @@ -3333,6 +3478,27 @@ "$ref": "#/components/schemas/card_brand" } }, + "card_customer": { + "type": "object", + "title": "Card Customer Information", + "description": "The details about a customer in PayPal's system of record.", + "allOf": [ + { + "$ref": "#/components/schemas/customer" + }, + { + "properties": { + "merchant_customer_id": { + "description": "Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.", + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[0-9a-zA-Z-_.^*$@#]+$" + } + } + } + ] + }, "card_from_request": { "type": "object", "title": "Card from Request", @@ -3352,6 +3518,86 @@ } } }, + "card_request": { + "type": "object", + "title": "Card", + "description": "The payment card to use to fund a payment. Can be a credit or debit card.", + "properties": { + "name": { + "type": "string", + "description": "The card holder's name as it appears on the card.", + "maxLength": 300, + "minLength": 1, + "pattern": "^.{1,300}$" + }, + "number": { + "type": "string", + "description": "The primary account number (PAN) for the payment card.", + "pattern": "^[0-9]{13,19}$", + "minLength": 13, + "maxLength": 19 + }, + "expiry": { + "description": "The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6) For example: 2028-04", + "$ref": "#/components/schemas/date_year_month" + }, + "security_code": { + "type": "string", + "description": "The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when `payment_initiator=MERCHANT`.", + "pattern": "^[0-9]{3,4}$", + "minLength": 3, + "maxLength": 4 + }, + "type": { + "description": "The payment card type.", + "$ref": "#/components/schemas/card_type" + }, + "brand": { + "description": "The card brand or network. Typically used in the response.", + "$ref": "#/components/schemas/card_brand" + }, + "billing_address": { + "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", + "type": "object", + "title": "Portable Postal Address (Medium-Grained)", + "properties": { + "address_line_1": { + "type": "string", + "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", + "maxLength": 300 + }, + "address_line_2": { + "type": "string", + "description": "The second line of the address, for example, a suite or apartment number.", + "maxLength": 300 + }, + "admin_area_2": { + "type": "string", + "description": "A city, town, or village. Smaller than `admin_area_level_1`.", + "maxLength": 120 + }, + "admin_area_1": { + "type": "string", + "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", + "maxLength": 300 + }, + "postal_code": { + "type": "string", + "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", + "maxLength": 60 + }, + "country_code": { + "$ref": "#/components/schemas/country_code" + } + }, + "required": ["country_code"] + }, + "attributes": { + "description": "Additional attributes associated with the use of this card.", + "$ref": "#/components/schemas/card_attributes" + } + } + }, "card_response": { "type": "object", "title": "Card Response", @@ -3397,6 +3643,9 @@ "bin_details": { "description": "Bank Identification Number (BIN) details used to fund a payment.", "$ref": "#/components/schemas/bin_details" + }, + "stored_credential": { + "$ref": "#/components/schemas/card_stored_credential" } } }, @@ -3466,6 +3715,26 @@ } ] }, + "card_stored_credential": { + "type": "object", + "title": "Card Stored Credential", + "description": "Provides additional details to process a payment using a `card` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
", + "properties": { + "payment_initiator": { + "$ref": "#/components/schemas/payment_initiator" + }, + "payment_type": { + "$ref": "#/components/schemas/stored_payment_source_payment_type" + }, + "usage": { + "$ref": "#/components/schemas/stored_payment_source_usage_type" + }, + "previous_network_transaction_reference": { + "$ref": "#/components/schemas/network_transaction_reference" + } + }, + "required": ["payment_initiator", "payment_type"] + }, "card_type": { "type": "string", "title": "Card Type", @@ -3497,6 +3766,49 @@ ], "enum": ["CREDIT", "DEBIT", "PREPAID", "STORE", "UNKNOWN"] }, + "card_vault_response": { + "type": "object", + "title": "Card Vault Response", + "description": "The details about a saved Card payment source.", + "properties": { + "id": { + "type": "string", + "description": "The PayPal-generated ID for the saved payment source.", + "minLength": 1, + "maxLength": 255 + }, + "status": { + "title": "Vault Status", + "type": "string", + "description": "The vault status.", + "minLength": 1, + "maxLength": 255, + "pattern": "^[0-9A-Z_]+$", + "x-enumDescriptions": [ + { + "value": "VAULTED", + "description": "The payment source has been saved in your customer's vault. This vault status reflects `/v3/vault` status." + }, + { + "value": "CREATED", + "description": "DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations." + }, + { + "value": "APPROVED", + "description": "Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault" + } + ], + "deprecated": true, + "enum": ["VAULTED", "CREATED", "APPROVED"] + }, + "links": { + "$ref": "#/components/schemas/definitions-link_description_list" + }, + "customer": { + "$ref": "#/components/schemas/card_customer" + } + } + }, "card_verification": { "type": "object", "title": "Card Verification", @@ -3552,9 +3864,12 @@ "currency_code": { "description": "The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.", "type": "string", - "format": "ppaas_common_currency_code_v2", "minLength": 3, - "maxLength": 3 + "maxLength": 3, + "x-security-classification": { + "data_class": "class4", + "data_category": "INTRINSIC" + } }, "customer": { "type": "object", @@ -4398,6 +4713,39 @@ } } }, + "network_transaction_reference": { + "type": "object", + "title": "Network Transaction Reference", + "description": "Reference values used by the card network to identify a transaction.", + "properties": { + "id": { + "type": "string", + "minLength": 9, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$", + "description": "Transaction reference id returned by the scheme. For Visa and Amex, this is the \"Tran id\" field in response. For MasterCard, this is the \"BankNet reference id\" field in response. For Discover, this is the \"NRID\" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -." + }, + "date": { + "type": "string", + "minLength": 4, + "maxLength": 4, + "pattern": "^[0-9]+$", + "description": "The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as \"BankNet reference date." + }, + "network": { + "description": "Name of the card network through which the transaction was routed.", + "$ref": "#/components/schemas/card_brand" + }, + "acquirer_reference_number": { + "type": "string", + "description": "Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.", + "minLength": 1, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]+$" + } + }, + "required": ["id"] + }, "pares_status": { "type": "string", "minLength": 1, @@ -4535,6 +4883,25 @@ } } }, + "payer_holding_preference": {}, + "payment_initiator": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[0-9A-Z_]+$", + "description": "The person or party who initiated or triggered the payment.", + "x-enumDescriptions": [ + { + "value": "CUSTOMER", + "description": "Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website." + }, + { + "value": "MERCHANT", + "description": "Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer." + } + ], + "enum": ["CUSTOMER", "MERCHANT"] + }, "payment_preferences": { "title": "Payment Preferences", "description": "The payment preferences for a subscription.", @@ -4606,100 +4973,23 @@ "description": "Cancels the subscription if the initial payment for the setup fails." } ], - "enum": ["CONTINUE", "CANCEL"] - }, - "payment_failure_threshold": { - "type": "integer", - "description": "The maximum number of payment failures before a subscription is suspended. For example, if `payment_failure_threshold` is `2`, the subscription automatically updates to the `SUSPEND` state if two consecutive payments fail.", - "minimum": 0, - "maximum": 999 - } - } - }, - "payment_source": { - "type": "object", - "title": "Payment Source", - "description": "The payment source definition. To be eligible to create subscription using debit or credit card, you will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its available only for non-3DS cards and for merchants in US and AU regions.", - "properties": { - "card": { - "type": "object", - "title": "Card", - "description": "The payment card to use to fund a payment. Can be a credit or debit card.", - "properties": { - "name": { - "type": "string", - "description": "The card holder's name as it appears on the card.", - "maxLength": 300, - "minLength": 1, - "pattern": "^.{1,300}$" - }, - "number": { - "type": "string", - "description": "The primary account number (PAN) for the payment card.", - "pattern": "^[0-9]{13,19}$", - "minLength": 13, - "maxLength": 19 - }, - "expiry": { - "description": "The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6).", - "$ref": "#/components/schemas/date_year_month" - }, - "security_code": { - "type": "string", - "description": "The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when `payment_initiator=MERCHANT`.", - "pattern": "^[0-9]{3,4}$", - "minLength": 3, - "maxLength": 4 - }, - "type": { - "description": "The payment card type.", - "$ref": "#/components/schemas/card_type" - }, - "brand": { - "description": "The card brand or network. Typically used in the response.", - "$ref": "#/components/schemas/card_brand" - }, - "billing_address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] - }, - "attributes": { - "description": "Additional attributes associated with the use of this card.", - "$ref": "#/components/schemas/card_attributes" - } - } + "enum": ["CONTINUE", "CANCEL"] + }, + "payment_failure_threshold": { + "type": "integer", + "description": "The maximum number of payment failures before a subscription is suspended. For example, if `payment_failure_threshold` is `2`, the subscription automatically updates to the `SUSPEND` state if two consecutive payments fail.", + "minimum": 0, + "maximum": 999 + } + } + }, + "payment_source": { + "type": "object", + "title": "Payment Source", + "description": "The payment source definition. To be eligible to create subscription using debit or credit card, you will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its available only for non-3DS cards and for merchants in US and AU regions.", + "properties": { + "card": { + "$ref": "#/components/schemas/card_request" } } }, @@ -5585,8 +5875,34 @@ } } }, + "email_address": { + "description": "The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.", + "$ref": "#/components/schemas/email_address" + }, + "phone_number": { + "description": "The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", + "type": "object", + "title": "Phone", + "properties": { + "country_code": { + "type": "string", + "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", + "minLength": 1, + "maxLength": 3, + "pattern": "^[0-9]{1,3}?$" + }, + "national_number": { + "type": "string", + "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", + "minLength": 1, + "maxLength": 14, + "pattern": "^[0-9]{1,14}?$" + } + }, + "required": ["country_code", "national_number"] + }, "type": { - "title": "Fullfillment Type", + "title": "Fulfillment Type", "description": "A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.", "type": "string", "minLength": 1, @@ -5737,6 +6053,51 @@ ], "enum": ["ON_SUCCESS"] }, + "stored_payment_source_payment_type": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[0-9A-Z_]+$", + "description": "Indicates the type of the stored payment_source payment.", + "x-enumDescriptions": [ + { + "value": "ONE_TIME", + "description": "One Time payment such as online purchase or donation. (e.g. Checkout with one-click)." + }, + { + "value": "RECURRING", + "description": "Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments)." + }, + { + "value": "UNSCHEDULED", + "description": "Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments)." + } + ], + "enum": ["ONE_TIME", "RECURRING", "UNSCHEDULED"] + }, + "stored_payment_source_usage_type": { + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^[0-9A-Z_]+$", + "default": "DERIVED", + "description": "Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file).", + "x-enumDescriptions": [ + { + "value": "FIRST", + "description": "Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment." + }, + { + "value": "SUBSEQUENT", + "description": "Indicates a payment using a stored payment_source which has been successfully used previously for a payment." + }, + { + "value": "DERIVED", + "description": "Indicates that PayPal will derive the value of `FIRST` or `SUBSEQUENT` based on data available to PayPal." + } + ], + "enum": ["FIRST", "SUBSEQUENT", "DERIVED"] + }, "subscriber": { "allOf": [ { @@ -5892,6 +6253,10 @@ "readOnly": true, "$ref": "#/components/schemas/date_time" }, + "payer_holding_preference": { + "description": "The payer's holding preference for subscriptions payments.", + "$ref": "#/components/schemas/payer_holding_preference" + }, "custom_id": { "type": "string", "description": "The custom id for the subscription. Can be invoice id.", @@ -6062,6 +6427,28 @@ }, "required": ["note", "capture_type", "amount"] }, + "subscription_collection": { + "title": "Subscription Collection", + "description": "The list of subscriptions.", + "type": "object", + "properties": { + "subscriptions": { + "$ref": "#/components/schemas/subscription_list" + }, + "links": { + "$ref": "#/components/schemas/link_description_list" + } + } + }, + "subscription_list": { + "type": "array", + "description": "An array of subscriptions.", + "minItems": 0, + "maxItems": 32767, + "items": { + "$ref": "#/components/schemas/subscription" + } + }, "subscription_request_post": { "title": "Create Subscription Request", "description": "The create subscription request details.", @@ -6100,6 +6487,8 @@ "deprecated": true }, "application_context": { + "description": "DEPRECATED. The application context, which customizes the payer experience during the subscription approval process with PayPal.", + "deprecated": true, "$ref": "#/components/schemas/application_context" }, "custom_id": { @@ -6157,11 +6546,13 @@ "description": "The label that overrides the business name in the PayPal account on the PayPal site.", "minLength": 1, "maxLength": 127, - "pattern": "^.*$" + "pattern": "^.*$", + "deprecated": true }, "locale": { "description": "The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`.", - "$ref": "#/components/schemas/language" + "$ref": "#/components/schemas/language", + "deprecated": true }, "shipping_preference": { "type": "string", @@ -6185,10 +6576,12 @@ "description": "Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages." } ], + "deprecated": true, "enum": ["GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"] }, "payment_method": { "description": "The customer and merchant payment preferences.", + "deprecated": true, "type": "object", "title": "Payment Method", "properties": { @@ -6202,14 +6595,16 @@ "format": "uri", "description": "The URL where the customer is redirected after the customer approves the payment.", "minLength": 10, - "maxLength": 4000 + "maxLength": 4000, + "deprecated": true }, "cancel_url": { "type": "string", "format": "uri", "description": "The URL where the customer is redirected after the customer cancels the payment.", "minLength": 10, - "maxLength": 4000 + "maxLength": 4000, + "deprecated": true } }, "required": ["return_url", "cancel_url"] @@ -7041,6 +7436,73 @@ ] } } + }, + { + "title": "INVALID_VAULT_ID", + "properties": { + "issue": { + "type": "string", + "enum": ["INVALID_VAULT_ID"] + }, + "description": { + "type": "string", + "enum": [ + "The specified vault id is invalid or could not be found.\"" + ] + } + } + }, + { + "title": "NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE", + "properties": { + "issue": { + "type": "string", + "enum": ["NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE"] + }, + "description": { + "type": "string", + "enum": [ + "The API caller or the merchant on whose behalf the API call is initiated is not allowed to vault the given source. Please contact PayPal customer support for assistance." + ] + } + } + } + ] + } + } + } + }, + "subscriptions.list-400": { + "properties": { + "details": { + "type": "array", + "items": { + "anyOf": [ + { + "title": "INVALID_PARAMETER_VALUE", + "properties": { + "issue": { + "type": "string", + "enum": ["INVALID_PARAMETER_VALUE"] + }, + "description": { + "type": "string", + "enum": ["The value of a field is invalid."] + } + } + }, + { + "title": "INVALID_URL_LENGTH", + "properties": { + "issue": { + "type": "string", + "enum": ["INVALID_URL_LENGTH"] + }, + "description": { + "type": "string", + "enum": ["URL length exceeds the maximum allowed length."] + } + } } ] } @@ -7871,7 +8333,7 @@ }, "three_d_secure_authentication_response": { "type": "object", - "title": "3D Secure Authentication Response", + "title": "Response of 3D Secure Authentication", "description": "Results of 3D Secure Authentication.", "properties": { "authentication_status": { @@ -8037,56 +8499,6 @@ "$ref": "#/components/schemas/store_in_vault_instruction" } } - }, - "vault_response": { - "type": "object", - "title": "Vault Response", - "description": "The details about a saved payment source.", - "properties": { - "id": { - "type": "string", - "description": "The PayPal-generated ID for the saved payment source.", - "minLength": 1, - "maxLength": 255 - }, - "status": { - "title": "Vault Status", - "type": "string", - "description": "The vault status.", - "minLength": 1, - "maxLength": 255, - "pattern": "^[0-9A-Z_]+$", - "x-enumDescriptions": [ - { - "value": "VAULTED", - "description": "The payment source has been saved in your customer's vault. This vault status reflects `/v3/vault` status." - }, - { - "value": "CREATED", - "description": "DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations." - }, - { - "value": "APPROVED", - "description": "Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault" - } - ], - "deprecated": true, - "enum": ["VAULTED", "CREATED", "APPROVED"] - }, - "customer": { - "type": "object", - "title": "Customer Information", - "description": "The details about a customer in PayPal's system of record.", - "properties": { - "id": { - "$ref": "#/components/schemas/merchant_partner_customer_id" - } - } - }, - "links": { - "$ref": "#/components/schemas/definitions-link_description_list" - } - } } }, "parameters": { @@ -8138,7 +8550,7 @@ "schema": { "type": "integer", "minimum": 1, - "maximum": 100000, + "maximum": 10000000, "default": 1 } }, @@ -8160,6 +8572,117 @@ "type": "string" } }, + "paypal_client_metadata_id": { + "name": "PayPal-Client-Metadata-Id", + "in": "header", + "description": "The PayPal Client Metadata Id(CMID) is used to provide device-specific information to PayPal's risk engine. This is crucial for transactions that require device-specific risk assessments. Merchants typically use the Paypal SDK that automatically submits the CMID or they use tools like Fraudnet JS for web or Magnes JS for mobile to generate the CMID on the frontend and then pass it to the API as part of the request headers.", + "required": false, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 36 + } + }, + "plan_ids": { + "name": "plan_ids", + "in": "query", + "description": "Filters the response by list of plan IDs. Filter supports upto 70 plan IDs. URLs should not exceed a length of 2000 characters.", + "required": false, + "schema": { + "type": "string", + "minimum": 3, + "maximum": 1890 + } + }, + "statuses": { + "name": "statuses", + "in": "query", + "description": "Filters the response by list of subscription statuses.", + "x-enumDescriptions": [ + { + "value": "ACTIVE", + "description": "Active state of the subscription." + }, + { + "value": "SUSPENDED", + "description": "Suspended state of the subscription." + }, + { + "value": "CANCELLED", + "description": "Cancelled state of the subscription." + }, + { + "value": "EXPIRED", + "description": "Expired state of the subscription." + } + ], + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 70, + "pattern": "^[A-Z_,]+$" + }, + "enum": ["ACTIVE", "SUSPENDED", "CANCELLED", "EXPIRED"] + }, + "created_after": { + "name": "created_after", + "in": "query", + "required": false, + "description": "Filters the response by subscription creation start time for a range of subscriptions.", + "schema": { + "type": "string", + "minLength": 20, + "maxLength": 64, + "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$" + } + }, + "created_before": { + "name": "created_before", + "in": "query", + "required": false, + "description": "Filters the response by subscription creation end time for a range of subscriptions.", + "schema": { + "type": "string", + "minLength": 20, + "maxLength": 64, + "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$" + } + }, + "status_updated_before": { + "name": "status_updated_before", + "in": "query", + "required": false, + "description": "Filters the response by status update start time for a range of subscriptions.", + "schema": { + "type": "string", + "minLength": 20, + "maxLength": 64, + "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$" + } + }, + "status_updated_after": { + "name": "status_updated_after", + "in": "query", + "required": false, + "description": "Filters the response by status update end time for a range of subscriptions.", + "schema": { + "type": "string", + "minLength": 20, + "maxLength": 64, + "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$" + } + }, + "filter": { + "name": "filter", + "in": "query", + "description": "Filter the response using complex expressions that could use comparison operators like ge, gt, le, lt and logical operators such as 'and' and 'or'.", + "required": false, + "schema": { + "type": "string", + "minLength": 0, + "maxLength": 100 + } + }, "fields": { "name": "fields", "in": "query", diff --git a/openapi/checkout_orders_v2.json b/openapi/checkout_orders_v2.json index 5096709..376ea1d 100644 --- a/openapi/checkout_orders_v2.json +++ b/openapi/checkout_orders_v2.json @@ -3,7 +3,7 @@ "info": { "title": "Orders", "description": "An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders.", - "version": "2.25", + "version": "2.26", "contact": {} }, "servers": [ @@ -1229,6 +1229,17 @@ } }, "schemas": { + "2": { + "type": "object", + "title": "Payer", + "description": "The customer who approves and pays for the order. The customer is also known as the payer.", + "format": "payer_v1" + }, + "3": { + "type": "object", + "title": "Order Authorize Response", + "description": "The order authorize response." + }, "400": { "properties": { "details": { @@ -3424,6 +3435,7 @@ } } }, + "3_definition_link_description": {}, "account_id": { "type": "string", "title": "PayPal Account Identifier", @@ -3458,6 +3470,42 @@ } } }, + "address": { + "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", + "type": "object", + "title": "Portable Postal Address (Medium-Grained)", + "properties": { + "address_line_1": { + "type": "string", + "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", + "maxLength": 300 + }, + "address_line_2": { + "type": "string", + "description": "The second line of the address, for example, a suite or apartment number.", + "maxLength": 300 + }, + "admin_area_2": { + "type": "string", + "description": "A city, town, or village. Smaller than `admin_area_level_1`.", + "maxLength": 120 + }, + "admin_area_1": { + "type": "string", + "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", + "maxLength": 300 + }, + "postal_code": { + "type": "string", + "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", + "maxLength": 60 + }, + "country_code": { + "$ref": "#/components/schemas/country_code" + } + }, + "required": ["country_code"] + }, "amount_breakdown": { "type": "object", "description": "The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.", @@ -3538,19 +3586,7 @@ "$ref": "#/components/schemas/email_address" }, "phone_number": { - "description": "The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", - "type": "object", - "title": "Phone", - "properties": { - "national_number": { - "type": "string", - "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 14, - "pattern": "^[0-9]{1,14}?$" - } - }, - "required": ["national_number"] + "$ref": "#/components/schemas/phone_number" }, "card": { "description": "The payment card information.", @@ -3638,40 +3674,7 @@ "$ref": "#/components/schemas/card_stored_credential" }, "billing_address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/billing_address" }, "country_code": { "$ref": "#/components/schemas/country_code-2", @@ -3689,79 +3692,7 @@ "$ref": "#/components/schemas/money" }, "tokenized_card": { - "description": "The payment card to use to fund a payment. Can be a credit or debit card.", - "type": "object", - "title": "Card", - "properties": { - "name": { - "type": "string", - "description": "The card holder's name as it appears on the card.", - "maxLength": 300, - "minLength": 1, - "pattern": "^.{1,300}$" - }, - "number": { - "type": "string", - "description": "The primary account number (PAN) for the payment card.", - "pattern": "^[0-9]{13,19}$", - "minLength": 13, - "maxLength": 19 - }, - "expiry": { - "description": "The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6) For example: 2028-04", - "$ref": "#/components/schemas/date_year_month" - }, - "card_type": { - "description": "The card brand or network. Typically used in the response.", - "readOnly": true, - "$ref": "#/components/schemas/card_brand", - "deprecated": true - }, - "type": { - "description": "The payment card type.", - "$ref": "#/components/schemas/card_type" - }, - "brand": { - "description": "The card brand or network. Typically used in the response.", - "$ref": "#/components/schemas/card_brand" - }, - "billing_address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] - } - } + "$ref": "#/components/schemas/tokenized_card" }, "device_manufacturer_id": { "description": "Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party and supports Unicode.", @@ -3869,19 +3800,7 @@ "$ref": "#/components/schemas/email_address" }, "phone_number": { - "description": "The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", - "type": "object", - "title": "Phone", - "properties": { - "national_number": { - "type": "string", - "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 14, - "pattern": "^[0-9]{1,14}?$" - } - }, - "required": ["national_number"] + "$ref": "#/components/schemas/phone_number" }, "decrypted_token": { "description": "The decrypted payload details for the apple pay token.", @@ -4153,6 +4072,42 @@ "maxLength": 11, "pattern": "^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$" }, + "billing_address": { + "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", + "type": "object", + "title": "Portable Postal Address (Medium-Grained)", + "properties": { + "address_line_1": { + "type": "string", + "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", + "maxLength": 300 + }, + "address_line_2": { + "type": "string", + "description": "The second line of the address, for example, a suite or apartment number.", + "maxLength": 300 + }, + "admin_area_2": { + "type": "string", + "description": "A city, town, or village. Smaller than `admin_area_level_1`.", + "maxLength": 120 + }, + "admin_area_1": { + "type": "string", + "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", + "maxLength": 300 + }, + "postal_code": { + "type": "string", + "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", + "maxLength": 60 + }, + "country_code": { + "$ref": "#/components/schemas/country_code" + } + }, + "required": ["country_code"] + }, "billing_agreement_id": { "type": "string", "description": "The PayPal billing agreement ID. References an approved recurring payment for goods or services.", @@ -4652,6 +4607,31 @@ } } }, + "card": { + "description": "The payment card used to fund a Google Pay payment. Can be a credit or debit card.", + "type": "object", + "title": "Google Pay Card", + "properties": { + "name": { + "type": "string", + "description": "The card holder's name as it appears on the card.", + "maxLength": 300, + "minLength": 1, + "pattern": "^.{1,300}$" + }, + "type": { + "description": "The payment card type.", + "$ref": "#/components/schemas/card_type" + }, + "brand": { + "description": "The card brand or network. Typically used in the response.", + "$ref": "#/components/schemas/card_brand" + }, + "billing_address": { + "$ref": "#/components/schemas/card_billing_address" + } + } + }, "card_attributes": { "type": "object", "title": "Card Attributes", @@ -4680,6 +4660,42 @@ } } }, + "card_billing_address": { + "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", + "type": "object", + "title": "Portable Postal Address (Medium-Grained)", + "properties": { + "address_line_1": { + "type": "string", + "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", + "maxLength": 300 + }, + "address_line_2": { + "type": "string", + "description": "The second line of the address, for example, a suite or apartment number.", + "maxLength": 300 + }, + "admin_area_2": { + "type": "string", + "description": "A city, town, or village. Smaller than `admin_area_level_1`.", + "maxLength": 120 + }, + "admin_area_1": { + "type": "string", + "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", + "maxLength": 300 + }, + "postal_code": { + "type": "string", + "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", + "maxLength": 60 + }, + "country_code": { + "$ref": "#/components/schemas/country_code" + } + }, + "required": ["country_code"] + }, "card_brand": { "type": "string", "title": "Card Brand", @@ -4946,40 +4962,7 @@ "maxLength": 4 }, "billing_address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/billing_address" }, "attributes": { "description": "Additional attributes associated with the use of this card.", @@ -5295,19 +5278,7 @@ "$ref": "#/components/schemas/labels_list" }, "payee": { - "description": "The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.", - "type": "object", - "title": "Payee Base", - "properties": { - "email_address": { - "description": "The email address of merchant.", - "$ref": "#/components/schemas/email" - }, - "merchant_id": { - "description": "The encrypted PayPal account ID of the merchant.", - "$ref": "#/components/schemas/account_id" - } - } + "$ref": "#/components/schemas/definitions-payee" }, "amount": { "description": "Amount that was charged to the cobranded card.", @@ -5368,16 +5339,6 @@ "data_category": "INTRINSIC" } }, - "currency_code-2": { - "description": "The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.", - "type": "string", - "minLength": 3, - "maxLength": 3, - "x-security-classification": { - "data_class": "class4", - "data_category": "INTRINSIC" - } - }, "customer": { "type": "object", "title": "Customer Information", @@ -5395,21 +5356,24 @@ "$ref": "#/components/schemas/phone_with_type" }, "name": { - "description": "The name of the party.", - "type": "object", - "title": "Name", - "properties": { - "given_name": { - "type": "string", - "description": "When the party is a person, the party's given, or first, name.", - "maxLength": 140 - }, - "surname": { - "type": "string", - "description": "When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.", - "maxLength": 140 - } - } + "$ref": "#/components/schemas/name" + } + } + }, + "customer_name": { + "description": "The name of the party.", + "type": "object", + "title": "Name", + "properties": { + "given_name": { + "type": "string", + "description": "When the party is a person, the party's given, or first, name.", + "maxLength": 140 + }, + "surname": { + "type": "string", + "description": "When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.", + "maxLength": 140 } } }, @@ -5436,6 +5400,69 @@ "maxLength": 7, "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$" }, + "definitions-2": { + "type": "object", + "title": "Vaulted PayPal Wallet Common Attributes", + "description": "Resource consolidating common request and response attributes for vaulting PayPal Wallet.", + "required": ["usage_type"] + }, + "definitions-card": { + "description": "The payment card used to fund a Google Pay payment. Can be a credit or debit card.", + "type": "object", + "title": "Google Pay Card", + "properties": { + "name": { + "type": "string", + "description": "The card holder's name as it appears on the card.", + "maxLength": 300, + "minLength": 1, + "pattern": "^.{1,300}$" + }, + "number": { + "type": "string", + "description": "The primary account number (PAN) for the payment card.", + "pattern": "^[0-9]{13,19}$", + "minLength": 13, + "maxLength": 19 + }, + "expiry": { + "description": "The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6).", + "$ref": "#/components/schemas/date_year_month" + }, + "last_digits": { + "type": "string", + "description": "The last digits of the payment card.", + "pattern": "^[0-9]{2,4}$", + "minLength": 2, + "maxLength": 4, + "readOnly": true + }, + "type": { + "description": "The payment card type.", + "$ref": "#/components/schemas/card_type" + }, + "brand": { + "description": "The card brand or network. Typically used in the response.", + "$ref": "#/components/schemas/card_brand" + }, + "billing_address": { + "$ref": "#/components/schemas/card_billing_address" + } + } + }, + "definitions-customer": { + "type": "object", + "title": "Customer Information", + "description": "This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.", + "properties": { + "id": { + "$ref": "#/components/schemas/merchant_partner_customer_id" + }, + "name": { + "$ref": "#/components/schemas/customer_name" + } + } + }, "definitions-link_description_list": { "type": "array", "description": "An array of request-related HATEOAS links.", @@ -5444,6 +5471,84 @@ "$ref": "#/components/schemas/link_description" } }, + "definitions-name": { + "description": "The name of the party.", + "type": "object", + "title": "Name", + "properties": { + "full_name": { + "type": "string", + "description": "When the party is a person, the party's full name.", + "maxLength": 300 + } + } + }, + "definitions-payee": { + "description": "The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.", + "type": "object", + "title": "Payee Base", + "properties": { + "email_address": { + "description": "The email address of merchant.", + "$ref": "#/components/schemas/email" + }, + "merchant_id": { + "description": "The encrypted PayPal account ID of the merchant.", + "$ref": "#/components/schemas/account_id" + } + } + }, + "definitions-payment_source": { + "type": "object", + "title": "Payment Source", + "description": "The payment source definition.", + "properties": { + "card": { + "$ref": "#/components/schemas/card_request" + }, + "token": { + "$ref": "#/components/schemas/token" + }, + "paypal": { + "description": "Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.", + "$ref": "#/components/schemas/paypal_wallet" + }, + "apple_pay": { + "description": "ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.", + "$ref": "#/components/schemas/apple_pay_request" + }, + "google_pay": { + "description": "Google Pay payment source, allows buyer to pay using Google Pay.", + "$ref": "#/components/schemas/google_pay_request" + }, + "venmo": { + "description": "Information needed to indicate that Venmo is being used to fund the payment.", + "$ref": "#/components/schemas/venmo_wallet_request" + } + } + }, + "definitions-phone_number": { + "description": "The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", + "type": "object", + "title": "Phone", + "properties": { + "country_code": { + "type": "string", + "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", + "minLength": 1, + "maxLength": 3, + "pattern": "^[0-9]{1,3}?$" + }, + "national_number": { + "type": "string", + "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", + "minLength": 1, + "maxLength": 14, + "pattern": "^[0-9]{1,14}?$" + } + }, + "required": ["country_code", "national_number"] + }, "definitions-platform_fee_list": { "type": "array", "description": "An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.", @@ -5462,6 +5567,58 @@ "$ref": "#/components/schemas/purchase_unit_request" } }, + "definitions-shipping_address": { + "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", + "type": "object", + "title": "Portable Postal Address (Medium-Grained)", + "properties": { + "admin_area_2": { + "type": "string", + "description": "A city, town, or village. Smaller than `admin_area_level_1`.", + "maxLength": 120 + }, + "admin_area_1": { + "type": "string", + "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", + "maxLength": 300 + }, + "postal_code": { + "type": "string", + "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", + "maxLength": 60 + }, + "country_code": { + "$ref": "#/components/schemas/country_code" + } + }, + "required": ["country_code"] + }, + "definitions-shipping_option": { + "description": "The options that the payee or merchant offers to the payer to ship or pick up their items.", + "type": "object", + "title": "Shipping Option", + "properties": { + "id": { + "type": "string", + "description": "A unique ID that identifies a payer-selected shipping option.", + "maxLength": 127 + }, + "label": { + "type": "string", + "description": "A description that the payer sees, which helps them choose an appropriate shipping option. For example, `Free Shipping`, `USPS Priority Shipping`, `Expédition prioritaire USPS`, or `USPS yōuxiān fā huò`. Localize this description to the payer's locale.", + "maxLength": 127 + }, + "type": { + "description": "A classification for the method of purchase fulfillment.", + "$ref": "#/components/schemas/shipping_type" + }, + "amount": { + "description": "The shipping cost for the selected option.", + "$ref": "#/components/schemas/money" + } + }, + "required": ["id", "label"] + }, "definitions-shipping_option_list": { "type": "array", "minItems": 1, @@ -5885,6 +6042,25 @@ } } }, + "error_429": { + "type": "object", + "title": "Too many requests", + "description": "Too many requests. Blocked due to rate limiting.", + "properties": { + "name": { + "type": "string", + "enum": ["RATE_LIMIT_REACHED"] + }, + "message": { + "type": "string", + "enum": ["Too many requests. Blocked due to rate limiting."] + }, + "debug_id": { + "type": "string", + "description": "The PayPal internal ID. Used for correlation purposes." + } + } + }, "error_500": { "type": "object", "title": "Internal Server Error", @@ -5982,6 +6158,9 @@ { "$ref": "#/components/schemas/error_422" }, + { + "$ref": "#/components/schemas/error_429" + }, { "$ref": "#/components/schemas/error_500" }, @@ -6124,62 +6303,6 @@ } } }, - "experience_context_swish": { - "type": "object", - "title": "Experience Context Swish", - "description": "Customizes the payer experience during the approval process for the payment.", - "properties": { - "brand_name": { - "type": "string", - "description": "The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.", - "minLength": 1, - "maxLength": 127, - "pattern": "^.*$" - }, - "locale": { - "description": "The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`.", - "$ref": "#/components/schemas/language" - }, - "shipping_preference": { - "type": "string", - "description": "The location from which the shipping address is derived.", - "minLength": 1, - "maxLength": 24, - "pattern": "^[A-Z0-9_]+$", - "default": "GET_FROM_FILE", - "x-enumDescriptions": [ - { - "value": "GET_FROM_FILE", - "description": "Get the customer-provided shipping address on the PayPal site." - }, - { - "value": "NO_SHIPPING", - "description": "Redacts the shipping address from the PayPal site. Recommended for digital goods." - }, - { - "value": "SET_PROVIDED_ADDRESS", - "description": "Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages." - } - ], - "enum": ["GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"] - }, - "return_url": { - "description": "The URL where the customer is redirected after the customer approves the payment.", - "format": "uri", - "$ref": "#/components/schemas/url" - }, - "cancel_url": { - "description": "The URL where the customer is redirected after the customer cancels the payment.", - "format": "uri", - "$ref": "#/components/schemas/url" - }, - "return_intent_url": { - "description": "The URL where we identify whether intent_url field should be returned in the response.", - "format": "uri", - "$ref": "#/components/schemas/url" - } - } - }, "frequency": {}, "full_name": { "type": "string", @@ -6240,26 +6363,7 @@ "$ref": "#/components/schemas/email_address" }, "phone_number": { - "description": "The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", - "type": "object", - "title": "Phone", - "properties": { - "country_code": { - "type": "string", - "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 3, - "pattern": "^[0-9]{1,3}?$" - }, - "national_number": { - "type": "string", - "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 14, - "pattern": "^[0-9]{1,14}?$" - } - }, - "required": ["country_code", "national_number"] + "$ref": "#/components/schemas/google_pay_definitions-phone_number" }, "card": { "description": "The Card from Google Pay Wallet used to fund the payment.", @@ -6297,40 +6401,7 @@ "$ref": "#/components/schemas/card_brand" }, "billing_address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/billing_address" }, "authentication_result": { "$ref": "#/components/schemas/authentication_response" @@ -6370,81 +6441,7 @@ "enum": ["CARD"] }, "card": { - "description": "The payment card used to fund a Google Pay payment. Can be a credit or debit card.", - "type": "object", - "title": "Google Pay Card", - "properties": { - "name": { - "type": "string", - "description": "The card holder's name as it appears on the card.", - "maxLength": 300, - "minLength": 1, - "pattern": "^.{1,300}$" - }, - "number": { - "type": "string", - "description": "The primary account number (PAN) for the payment card.", - "pattern": "^[0-9]{13,19}$", - "minLength": 13, - "maxLength": 19 - }, - "expiry": { - "description": "The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6).", - "$ref": "#/components/schemas/date_year_month" - }, - "last_digits": { - "type": "string", - "description": "The last digits of the payment card.", - "pattern": "^[0-9]{2,4}$", - "minLength": 2, - "maxLength": 4, - "readOnly": true - }, - "type": { - "description": "The payment card type.", - "$ref": "#/components/schemas/card_type" - }, - "brand": { - "description": "The card brand or network. Typically used in the response.", - "$ref": "#/components/schemas/card_brand" - }, - "billing_address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] - } - } + "$ref": "#/components/schemas/definitions-card" }, "authentication_method": { "description": "Authentication Method which is used for the card transaction.", @@ -6479,6 +6476,28 @@ }, "required": ["payment_method", "card", "authentication_method"] }, + "google_pay_definitions-phone_number": { + "description": "The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", + "type": "object", + "title": "Phone", + "properties": { + "country_code": { + "type": "string", + "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", + "minLength": 1, + "maxLength": 3, + "pattern": "^[0-9]{1,3}?$" + }, + "national_number": { + "type": "string", + "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", + "minLength": 1, + "maxLength": 14, + "pattern": "^[0-9]{1,14}?$" + } + }, + "required": ["country_code", "national_number"] + }, "google_pay_experience_context": { "type": "object", "title": "Google Pay Experience Context", @@ -6511,84 +6530,10 @@ "$ref": "#/components/schemas/email_address" }, "phone_number": { - "description": "The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", - "type": "object", - "title": "Phone", - "properties": { - "country_code": { - "type": "string", - "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 3, - "pattern": "^[0-9]{1,3}?$" - }, - "national_number": { - "type": "string", - "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 14, - "pattern": "^[0-9]{1,14}?$" - } - }, - "required": ["country_code", "national_number"] + "$ref": "#/components/schemas/google_pay_request_definitions-phone_number" }, "card": { - "description": "The payment card used to fund a Google Pay payment. Can be a credit or debit card.", - "type": "object", - "title": "Google Pay Card", - "properties": { - "name": { - "type": "string", - "description": "The card holder's name as it appears on the card.", - "maxLength": 300, - "minLength": 1, - "pattern": "^.{1,300}$" - }, - "type": { - "description": "The payment card type.", - "$ref": "#/components/schemas/card_type" - }, - "brand": { - "description": "The card brand or network. Typically used in the response.", - "$ref": "#/components/schemas/card_brand" - }, - "billing_address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] - } - } + "$ref": "#/components/schemas/card" }, "decrypted_token": { "description": "The decrypted payload details for the Google Pay token.", @@ -6601,10 +6546,32 @@ "attributes": { "$ref": "#/components/schemas/google_pay_attributes" }, - "experience_context": { - "$ref": "#/components/schemas/google_pay_experience_context" + "experience_context": { + "$ref": "#/components/schemas/google_pay_experience_context" + } + } + }, + "google_pay_request_definitions-phone_number": { + "description": "The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", + "type": "object", + "title": "Phone", + "properties": { + "country_code": { + "type": "string", + "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", + "minLength": 1, + "maxLength": 3, + "pattern": "^[0-9]{1,3}?$" + }, + "national_number": { + "type": "string", + "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", + "minLength": 1, + "maxLength": 14, + "pattern": "^[0-9]{1,14}?$" } - } + }, + "required": ["country_code", "national_number"] }, "iban_last_chars": { "type": "string", @@ -6756,6 +6723,94 @@ "$ref": "#/components/schemas/item" } }, + "item_request": { + "type": "object", + "title": "Item Request", + "description": "The details for the items to be purchased.", + "properties": { + "name": { + "type": "string", + "description": "The item name or title.", + "minLength": 1, + "maxLength": 127 + }, + "unit_amount": { + "description": "The item price or rate per unit. If you specify unit_amount, purchase_units[].amount.breakdown.item_total is required. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number.", + "$ref": "#/components/schemas/money" + }, + "tax": { + "description": "The item tax for each unit. If tax is specified, purchase_units[].amount.breakdown.tax_total is required. Must equal tax * quantity for all items. tax.value can not be a negative number.", + "$ref": "#/components/schemas/money" + }, + "quantity": { + "type": "string", + "description": "The item quantity. Must be a whole number.", + "maxLength": 10, + "pattern": "^[1-9][0-9]{0,9}$" + }, + "description": { + "type": "string", + "description": "
This field accepts a maximum of 2048 total characters (including spaces). Excess characters are automatically truncated.
The detailed item description.", + "maxLength": 4000 + }, + "sku": { + "type": "string", + "description": "The stock keeping unit (SKU) for the item.", + "maxLength": 127 + }, + "url": { + "type": "string", + "format": "uri", + "minLength": 1, + "maxLength": 2048, + "description": "The URL to the item being purchased. Visible to buyer and used in buyer experiences." + }, + "category": { + "type": "string", + "description": "The item category type.", + "x-enumDescriptions": [ + { + "value": "DIGITAL_GOODS", + "description": "Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product." + }, + { + "value": "PHYSICAL_GOODS", + "description": "A tangible item that can be shipped with proof of delivery." + }, + { + "value": "DONATION", + "description": "A contribution or gift for which no good or service is exchanged, usually to a not for profit organization." + } + ], + "minLength": 1, + "maxLength": 20, + "enum": ["DIGITAL_GOODS", "PHYSICAL_GOODS", "DONATION"] + }, + "image_url": { + "type": "string", + "format": "uri", + "description": "The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.", + "minLength": 1, + "maxLength": 2048, + "pattern": "^(https:)([/|.|\\w|\\s|-])*\\.(?:jpg|gif|png|jpeg|JPG|GIF|PNG|JPEG)" + }, + "upc": { + "description": "The Universal Product Code of the item.", + "$ref": "#/components/schemas/universal_product_code" + }, + "billing_plan": { + "$ref": "#/components/schemas/order_billing_plan" + } + }, + "required": ["name", "unit_amount", "quantity"] + }, + "item_request_list": { + "type": "array", + "description": "An array of items that the customer purchases from the merchant.", + "items": { + "$ref": "#/components/schemas/item_request" + } + }, "labels": { "type": "string", "description": "Label for the cobranded card.", @@ -6815,40 +6870,7 @@ "$ref": "#/components/schemas/money" }, "shipping_address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/shipping_address" }, "ships_from_postal_code": { "type": "string", @@ -7101,6 +7123,23 @@ }, "required": ["name", "country_code"] }, + "name": { + "description": "The name of the party.", + "type": "object", + "title": "Name", + "properties": { + "given_name": { + "type": "string", + "description": "When the party is a person, the party's given, or first, name.", + "maxLength": 140 + }, + "surname": { + "type": "string", + "description": "When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.", + "maxLength": 140 + } + } + }, "net_amount_breakdown_item": { "type": "object", "title": "Net Amount Breakdown Item", @@ -7366,41 +7405,7 @@ "description": "The authorization of an order request.", "properties": { "payment_source": { - "description": "The payment source definition.", - "type": "object", - "title": "Payment Source", - "properties": { - "card": { - "$ref": "#/components/schemas/card_request" - }, - "token": { - "$ref": "#/components/schemas/token" - }, - "paypal": { - "description": "Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.", - "$ref": "#/components/schemas/paypal_wallet" - }, - "swish": { - "description": "The Sweden payment method Swish is an online payment method that enables consumers to pay online through their own bank.", - "$ref": "#/components/schemas/swish_request" - }, - "pix": { - "description": "PIX is a local payment method in Brazil, that enables consumers to pay online through their own bank.", - "$ref": "#/components/schemas/pix_request" - }, - "apple_pay": { - "description": "ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.", - "$ref": "#/components/schemas/apple_pay_request" - }, - "google_pay": { - "description": "Google Pay payment source, allows buyer to pay using Google Pay.", - "$ref": "#/components/schemas/google_pay_request" - }, - "venmo": { - "description": "Information needed to indicate that Venmo is being used to fund the payment.", - "$ref": "#/components/schemas/venmo_wallet_request" - } - } + "$ref": "#/components/schemas/definitions-payment_source" } } }, @@ -7418,35 +7423,7 @@ "readOnly": true }, "payment_source": { - "type": "object", - "title": "Payment Source Response", - "description": "The payment source used to fund the payment.", - "properties": { - "card": { - "$ref": "#/components/schemas/card_response" - }, - "paypal": { - "$ref": "#/components/schemas/paypal_wallet_response" - }, - "swish": { - "$ref": "#/components/schemas/swish" - }, - "apple_pay": { - "$ref": "#/components/schemas/apple_pay" - }, - "google_pay": { - "$ref": "#/components/schemas/google_pay" - }, - "venmo": { - "$ref": "#/components/schemas/venmo_wallet_response" - }, - "pix": { - "$ref": "#/components/schemas/pix" - }, - "crypto": { - "$ref": "#/components/schemas/crypto" - } - } + "$ref": "#/components/schemas/order_authorize_response_definitions-payment_source" }, "intent": { "$ref": "#/components/schemas/checkout_payment_intent" @@ -7470,12 +7447,35 @@ } }, { - "type": "object", - "title": "Order Authorize Response", - "description": "The order authorize response." + "$ref": "#/components/schemas/3" } ] }, + "order_authorize_response_definitions-payment_source": { + "type": "object", + "title": "Payment Source Response", + "description": "The payment source used to fund the payment.", + "properties": { + "card": { + "$ref": "#/components/schemas/card_response" + }, + "paypal": { + "$ref": "#/components/schemas/paypal_wallet_response" + }, + "apple_pay": { + "$ref": "#/components/schemas/apple_pay" + }, + "google_pay": { + "$ref": "#/components/schemas/google_pay" + }, + "venmo": { + "$ref": "#/components/schemas/venmo_wallet_response" + }, + "crypto": { + "$ref": "#/components/schemas/crypto" + } + } + }, "order_billing_plan": { "title": "Billing Plan", "description": "Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.", @@ -7504,41 +7504,7 @@ "description": "Completes an capture payment for an order.", "properties": { "payment_source": { - "type": "object", - "title": "Payment Source", - "description": "The payment source definition.", - "properties": { - "card": { - "$ref": "#/components/schemas/card_request" - }, - "token": { - "$ref": "#/components/schemas/token" - }, - "paypal": { - "description": "Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.", - "$ref": "#/components/schemas/paypal_wallet" - }, - "swish": { - "description": "The Sweden payment method Swish is an online payment method that enables consumers to pay online through their own bank.", - "$ref": "#/components/schemas/swish_request" - }, - "pix": { - "description": "PIX is a local payment method in Brazil, that enables consumers to pay online through their own bank.", - "$ref": "#/components/schemas/pix_request" - }, - "apple_pay": { - "description": "ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.", - "$ref": "#/components/schemas/apple_pay_request" - }, - "google_pay": { - "description": "Google Pay payment source, allows buyer to pay using Google Pay.", - "$ref": "#/components/schemas/google_pay_request" - }, - "venmo": { - "description": "Information needed to indicate that Venmo is being used to fund the payment.", - "$ref": "#/components/schemas/venmo_wallet_request" - } - } + "$ref": "#/components/schemas/definitions-payment_source" } } }, @@ -7704,56 +7670,10 @@ "pattern": "^[A-Z0-9-]+$" }, "shipping_address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/definitions-shipping_address" }, "shipping_option": { - "description": "The options that the payee or merchant offers to the payer to ship or pick up their items.", - "type": "object", - "title": "Shipping Option", - "properties": { - "id": { - "type": "string", - "description": "A unique ID that identifies a payer-selected shipping option.", - "maxLength": 127 - }, - "label": { - "type": "string", - "description": "A description that the payer sees, which helps them choose an appropriate shipping option. For example, `Free Shipping`, `USPS Priority Shipping`, `Expédition prioritaire USPS`, or `USPS yōuxiān fā huò`. Localize this description to the payer's locale.", - "maxLength": 127 - }, - "type": { - "description": "A classification for the method of purchase fulfillment.", - "$ref": "#/components/schemas/shipping_type" - }, - "amount": { - "description": "The shipping cost for the selected option.", - "$ref": "#/components/schemas/money" - } - }, - "required": ["id", "label"] + "$ref": "#/components/schemas/definitions-shipping_option" }, "purchase_units": { "$ref": "#/components/schemas/definitions-purchase_unit_request_list" @@ -13194,21 +13114,7 @@ { "properties": { "name": { - "description": "The name of the party.", - "type": "object", - "title": "Name", - "properties": { - "given_name": { - "type": "string", - "description": "When the party is a person, the party's given, or first, name.", - "maxLength": 140 - }, - "surname": { - "type": "string", - "description": "When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.", - "maxLength": 140 - } - } + "$ref": "#/components/schemas/name" }, "phone": { "description": "The phone number of the customer. Available only when you enable the **Contact Telephone Number** option in the **Profile & Settings** for the merchant's PayPal account. The `phone.phone_number` supports only `national_number`.", @@ -13223,48 +13129,12 @@ "$ref": "#/components/schemas/tax_info" }, "address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/address" } } }, { - "type": "object", - "title": "Payer", - "description": "The customer who approves and pays for the order. The customer is also known as the payer.", - "format": "payer_v1" + "$ref": "#/components/schemas/2" } ] }, @@ -13421,10 +13291,6 @@ "description": "The Sweden payment method Swish is an online payment method that enables consumers to pay online through their own bank.", "$ref": "#/components/schemas/swish_request" }, - "pix": { - "description": "PIX is a local payment method in Brazil, that enables consumers to pay online through their own bank.", - "$ref": "#/components/schemas/pix_request" - }, "mybank": { "description": "MyBank is an e-authorisation solution which enables safe digital payments and identity authentication through a consumer’s own online banking portal or mobile application. [More Details](https://www.mybank.eu/).", "$ref": "#/components/schemas/mybank_request" @@ -13509,9 +13375,6 @@ "venmo": { "$ref": "#/components/schemas/venmo_wallet_response" }, - "pix": { - "$ref": "#/components/schemas/pix" - }, "crypto": { "$ref": "#/components/schemas/crypto" } @@ -13531,21 +13394,7 @@ "$ref": "#/components/schemas/email" }, "name": { - "description": "The name of the party.", - "type": "object", - "title": "Name", - "properties": { - "given_name": { - "type": "string", - "description": "When the party is a person, the party's given, or first, name.", - "maxLength": 140 - }, - "surname": { - "type": "string", - "description": "When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.", - "maxLength": 140 - } - } + "$ref": "#/components/schemas/name" }, "phone": { "description": "The phone number of the customer. Available only when you enable the **Contact Telephone Number** option in the **Profile & Settings** for the merchant's PayPal account. The `phone.phone_number` supports only `national_number`.", @@ -13560,40 +13409,7 @@ "$ref": "#/components/schemas/tax_info" }, "address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/address" }, "attributes": { "description": "Additional attributes associated with the use of this wallet.", @@ -13749,10 +13565,7 @@ } }, { - "type": "object", - "title": "Vaulted PayPal Wallet Common Attributes", - "description": "Resource consolidating common request and response attributes for vaulting PayPal Wallet.", - "required": ["usage_type"] + "$ref": "#/components/schemas/definitions-2" }, { "description": "Attributes used to provide the instructions during vaulting of the PayPal Wallet." @@ -13974,21 +13787,7 @@ "enum": ["VERIFIED", "UNVERIFIED"] }, "name": { - "description": "The name of the party.", - "type": "object", - "title": "Name", - "properties": { - "given_name": { - "type": "string", - "description": "When the party is a person, the party's given, or first, name.", - "maxLength": 140 - }, - "surname": { - "type": "string", - "description": "When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.", - "maxLength": 140 - } - } + "$ref": "#/components/schemas/name" }, "phone_type": { "$ref": "#/components/schemas/phone_type" @@ -14013,40 +13812,7 @@ "$ref": "#/components/schemas/tax_info" }, "address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/address" }, "attributes": { "$ref": "#/components/schemas/paypal_wallet_attributes_response" @@ -14119,12 +13885,27 @@ "customer": { "$ref": "#/components/schemas/paypal_wallet_customer" } - } + } + }, + "phone": { + "type": "object", + "title": "Phone Number", + "description": "The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", + "properties": { + "national_number": { + "type": "string", + "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", + "minLength": 1, + "maxLength": 14, + "pattern": "^[0-9]{1,14}?$" + } + }, + "required": ["national_number"] }, - "phone": { + "phone_number": { + "description": "The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", "type": "object", - "title": "Phone Number", - "description": "The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", + "title": "Phone", "properties": { "national_number": { "type": "string", @@ -14158,133 +13939,11 @@ "$ref": "#/components/schemas/phone_type" }, "phone_number": { - "description": "The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", - "type": "object", - "title": "Phone", - "properties": { - "national_number": { - "type": "string", - "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 14, - "pattern": "^[0-9]{1,14}?$" - } - }, - "required": ["national_number"] + "$ref": "#/components/schemas/phone_number" } }, "required": ["phone_number"] }, - "pix": { - "type": "object", - "title": "Pix payment object", - "description": "Information needed to pay using Pix.", - "properties": { - "country_code": { - "description": "The two-character ISO 3166-1 purchase country code.", - "$ref": "#/components/schemas/country_code" - }, - "name": { - "description": "The name of the account holder associated with PIX.", - "$ref": "#/components/schemas/full_name" - }, - "email_address": { - "description": "The email address of the account holder associated with Pix.", - "$ref": "#/components/schemas/email_address" - }, - "phone_number": { - "description": "The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", - "type": "object", - "title": "Phone", - "properties": { - "country_code": { - "type": "string", - "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 3, - "pattern": "^[0-9]{1,3}?$" - }, - "national_number": { - "type": "string", - "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 14, - "pattern": "^[0-9]{1,14}?$" - } - }, - "required": ["country_code", "national_number"] - }, - "tax_info": { - "description": "The tax information of the account holder.", - "$ref": "#/components/schemas/tax_info" - }, - "currency_code": { - "$ref": "#/components/schemas/currency_code-2" - }, - "qr_details": { - "$ref": "#/components/schemas/qr_details" - } - } - }, - "pix_request": { - "type": "object", - "title": "Pix payment object", - "description": "Information needed to pay using Pix.", - "properties": { - "country_code": { - "description": "The two-character ISO 3166-1 purchase country code.", - "$ref": "#/components/schemas/country_code" - }, - "name": { - "description": "The name of the account holder associated with PIX.", - "$ref": "#/components/schemas/full_name" - }, - "email_address": { - "description": "The email address of the account holder associated with Pix.", - "$ref": "#/components/schemas/email_address" - }, - "phone_number": { - "description": "The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", - "type": "object", - "title": "Phone", - "properties": { - "country_code": { - "type": "string", - "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 3, - "pattern": "^[0-9]{1,3}?$" - }, - "national_number": { - "type": "string", - "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 14, - "pattern": "^[0-9]{1,14}?$" - } - }, - "required": ["country_code", "national_number"] - }, - "tax_info": { - "description": "The tax information of the account holder.", - "$ref": "#/components/schemas/tax_info" - }, - "currency_code": { - "$ref": "#/components/schemas/currency_code-2" - }, - "qr_details": { - "$ref": "#/components/schemas/qr_details" - } - }, - "required": [ - "country_code", - "name", - "email_address", - "phone_number", - "tax_info", - "currency_code" - ] - }, "platform_fee": { "type": "object", "title": "Platform Fee", @@ -15547,9 +15206,9 @@ }, "description": { "type": "string", - "description": "The purchase description. The maximum length of the character is dependent on the type of characters used. The character length is specified assuming a US ASCII character. Depending on type of character; (e.g. accented character, Japanese characters) the number of characters that that can be specified as input might not equal the permissible max length.", + "description": "
This field accepts a maximum of 127 total characters (including spaces). Excess characters are automatically truncated.
The purchase description. The maximum length of the character is dependent on the type of characters used. The character length is specified assuming a US ASCII character. Depending on type of character; (e.g. accented character, Japanese characters) the number of characters that that can be specified as input might not equal the permissible max length.", "minLength": 1, - "maxLength": 127 + "maxLength": 3000 }, "custom_id": { "type": "string", @@ -15565,12 +15224,12 @@ }, "soft_descriptor": { "type": "string", - "description": "The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement.

If an Order is paid using the \"PayPal Wallet\", the statement descriptor will appear in following format on the payer's card statement: PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor
Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit
The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement.
For example, if:Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.", + "description": "
This field accepts a maximum of 22 total characters (including spaces). Excess characters are automatically truncated.
The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement.

If an Order is paid using the \"PayPal Wallet\", the statement descriptor will appear in following format on the payer's card statement: PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor
Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit
The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement.
For example, if:Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.", "minLength": 1, - "maxLength": 22 + "maxLength": 1000 }, "items": { - "$ref": "#/components/schemas/item_list" + "$ref": "#/components/schemas/item_request_list" }, "shipping": { "description": "The name and address of the person to whom to ship the items.", @@ -15592,46 +15251,6 @@ "$ref": "#/components/schemas/purchase_unit_request" } }, - "qr_details": { - "type": "object", - "description": "QR details received from processor.", - "title": "QR Details", - "properties": { - "qr_expiry": { - "type": "string", - "description": "QR Expiry time in seconds", - "minLength": 3, - "maxLength": 6, - "pattern": "^[0-9]+$", - "x-security-classification": { - "data_class": "class4", - "data_category": "INTRINSIC" - } - }, - "qr_image": { - "type": "string", - "description": "QR image received from APM processor, The pattern is not provided because the value is defined by an external party.", - "minLength": 20, - "maxLength": 520, - "pattern": "^.*$", - "x-security-classification": { - "data_class": "class4", - "data_category": "INTRINSIC" - } - }, - "qr_payload": { - "type": "string", - "description": "QR payload received from APM processor, The pattern is not provided because the value is defined by an external party.", - "minLength": 20, - "maxLength": 520, - "pattern": "^.*$", - "x-security-classification": { - "data_class": "class4", - "data_category": "INTRINSIC" - } - } - } - }, "refund": { "type": "object", "title": "Refund", @@ -22785,48 +22404,56 @@ "SPEDISCI" ] }, + "shipping_address": { + "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", + "type": "object", + "title": "Portable Postal Address (Medium-Grained)", + "properties": { + "address_line_1": { + "type": "string", + "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", + "maxLength": 300 + }, + "address_line_2": { + "type": "string", + "description": "The second line of the address, for example, a suite or apartment number.", + "maxLength": 300 + }, + "admin_area_2": { + "type": "string", + "description": "A city, town, or village. Smaller than `admin_area_level_1`.", + "maxLength": 120 + }, + "admin_area_1": { + "type": "string", + "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", + "maxLength": 300 + }, + "postal_code": { + "type": "string", + "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", + "maxLength": 60 + }, + "country_code": { + "$ref": "#/components/schemas/country_code" + } + }, + "required": ["country_code"] + }, "shipping_detail": { "type": "object", "description": "The shipping details.", "title": "Shipping Details", "properties": { "name": { - "description": "The name of the party.", - "type": "object", - "title": "Name", - "properties": { - "full_name": { - "type": "string", - "description": "When the party is a person, the party's full name.", - "maxLength": 300 - } - } + "$ref": "#/components/schemas/definitions-name" }, "email_address": { "description": "The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.", "$ref": "#/components/schemas/email_address" }, "phone_number": { - "description": "The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", - "type": "object", - "title": "Phone", - "properties": { - "country_code": { - "type": "string", - "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 3, - "pattern": "^[0-9]{1,3}?$" - }, - "national_number": { - "type": "string", - "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).", - "minLength": 1, - "maxLength": 14, - "pattern": "^[0-9]{1,14}?$" - } - }, - "required": ["country_code", "national_number"] + "$ref": "#/components/schemas/definitions-phone_number" }, "type": { "title": "Fulfillment Type", @@ -22865,40 +22492,7 @@ "$ref": "#/components/schemas/shipping_option_list" }, "address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/address" } } }, @@ -23147,64 +22741,8 @@ } } }, - "swish": { - "type": "object", - "title": "swish payment object", - "description": "Information used to pay using swish.", - "properties": { - "name": { - "description": "The name of the account holder associated with this payment method.", - "$ref": "#/components/schemas/full_name" - }, - "country_code": { - "description": "The two-character ISO 3166-1 country code.", - "$ref": "#/components/schemas/country_code-2" - }, - "qr_data": { - "description": "QR data received from APM processor, The pattern is not provided because the value is defined by an external party.", - "type": "string", - "minLength": 50, - "maxLength": 520, - "pattern": "^.*$" - }, - "qr_image": { - "description": "QR image received from APM processor, The pattern is not provided because the value is defined by an external party.", - "type": "string", - "minLength": 75, - "maxLength": 80, - "pattern": "^.*$", - "x-security-classification": { - "data_class": "class4", - "data_category": "INTRINSIC" - } - }, - "intent_url": { - "description": "The URL to open the Swish app.", - "type": "string", - "format": "uri" - } - } - }, - "swish_request": { - "type": "object", - "title": "Payment request for Swish", - "description": "Information needed to pay using Swish.", - "properties": { - "name": { - "description": "The name of the account holder associated with this payment method.", - "$ref": "#/components/schemas/full_name" - }, - "country_code": { - "description": "The two-character ISO 3166-1 country code.", - "$ref": "#/components/schemas/country_code-2" - }, - "experience_context": { - "description": "Customizes the payer experience during the approval process for the payment.", - "$ref": "#/components/schemas/experience_context_swish" - } - }, - "required": ["name", "country_code"] - }, + "swish": {}, + "swish_request": {}, "tax_info": { "type": "object", "description": "The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required.", @@ -23282,6 +22820,84 @@ }, "required": ["id", "type"] }, + "tokenized_card": { + "description": "The payment card to use to fund a payment. Can be a credit or debit card.", + "type": "object", + "title": "Card", + "properties": { + "name": { + "type": "string", + "description": "The card holder's name as it appears on the card.", + "maxLength": 300, + "minLength": 1, + "pattern": "^.{1,300}$" + }, + "number": { + "type": "string", + "description": "The primary account number (PAN) for the payment card.", + "pattern": "^[0-9]{13,19}$", + "minLength": 13, + "maxLength": 19 + }, + "expiry": { + "description": "The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6) For example: 2028-04", + "$ref": "#/components/schemas/date_year_month" + }, + "card_type": { + "description": "The card brand or network. Typically used in the response.", + "readOnly": true, + "$ref": "#/components/schemas/card_brand", + "deprecated": true + }, + "type": { + "description": "The payment card type.", + "$ref": "#/components/schemas/card_type" + }, + "brand": { + "description": "The card brand or network. Typically used in the response.", + "$ref": "#/components/schemas/card_brand" + }, + "billing_address": { + "$ref": "#/components/schemas/tokenized_card_billing_address" + } + } + }, + "tokenized_card_billing_address": { + "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", + "type": "object", + "title": "Portable Postal Address (Medium-Grained)", + "properties": { + "address_line_1": { + "type": "string", + "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", + "maxLength": 300 + }, + "address_line_2": { + "type": "string", + "description": "The second line of the address, for example, a suite or apartment number.", + "maxLength": 300 + }, + "admin_area_2": { + "type": "string", + "description": "A city, town, or village. Smaller than `admin_area_level_1`.", + "maxLength": 120 + }, + "admin_area_1": { + "type": "string", + "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", + "maxLength": 300 + }, + "postal_code": { + "type": "string", + "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", + "maxLength": 60 + }, + "country_code": { + "$ref": "#/components/schemas/country_code" + } + }, + "required": ["country_code"] + }, "tracker": { "type": "object", "title": "Order Tracker Response.", @@ -23562,31 +23178,7 @@ "enum": ["VAULTED", "CREATED", "APPROVED"] }, "customer": { - "type": "object", - "title": "Customer Information", - "description": "This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.", - "properties": { - "id": { - "$ref": "#/components/schemas/merchant_partner_customer_id" - }, - "name": { - "description": "The name of the party.", - "type": "object", - "title": "Name", - "properties": { - "given_name": { - "type": "string", - "description": "When the party is a person, the party's given, or first, name.", - "maxLength": 140 - }, - "surname": { - "type": "string", - "description": "When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.", - "maxLength": 140 - } - } - } - } + "$ref": "#/components/schemas/definitions-customer" }, "links": { "$ref": "#/components/schemas/link_description_list" @@ -23810,61 +23402,14 @@ "maxLength": 50 }, "name": { - "description": "The name of the party.", - "type": "object", - "title": "Name", - "properties": { - "given_name": { - "type": "string", - "description": "When the party is a person, the party's given, or first, name.", - "maxLength": 140 - }, - "surname": { - "type": "string", - "description": "When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.", - "maxLength": 140 - } - } + "$ref": "#/components/schemas/name" }, "phone_number": { "description": "The phone number associated with the Venmo account, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Supports only the `national_number` property.", "$ref": "#/components/schemas/phone" }, "address": { - "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", - "type": "object", - "title": "Portable Postal Address (Medium-Grained)", - "properties": { - "address_line_1": { - "type": "string", - "description": "The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.", - "maxLength": 300 - }, - "address_line_2": { - "type": "string", - "description": "The second line of the address, for example, a suite or apartment number.", - "maxLength": 300 - }, - "admin_area_2": { - "type": "string", - "description": "A city, town, or village. Smaller than `admin_area_level_1`.", - "maxLength": 120 - }, - "admin_area_1": { - "type": "string", - "description": "The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:", - "maxLength": 300 - }, - "postal_code": { - "type": "string", - "description": "The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).", - "maxLength": 60 - }, - "country_code": { - "$ref": "#/components/schemas/country_code" - } - }, - "required": ["country_code"] + "$ref": "#/components/schemas/address" }, "attributes": { "$ref": "#/components/schemas/venmo_wallet_attributes_response" diff --git a/openapi/customer_partner_referrals_v2.json b/openapi/customer_partner_referrals_v2.json index fd56f9a..7496b7b 100644 --- a/openapi/customer_partner_referrals_v2.json +++ b/openapi/customer_partner_referrals_v2.json @@ -1224,6 +1224,9 @@ "description": "List of beneficial owners part of the entity. They can be either a Person or a business entity.", "$ref": "#/components/schemas/beneficial_owners" }, + "office_bearers": { + "$ref": "#/components/schemas/office_bearer_list" + }, "annual_sales_volume_range": { "description": "The range for the total annual sales volume of the business.", "$ref": "#/components/schemas/currency_range" @@ -1617,6 +1620,7 @@ "GOOGLE_PAY" ] }, + "office_bearer_list": {}, "capabilities_list": { "type": "array", "description": "An array of capabilities which the partner wants to enable for the selected products. Supported only when products are specified.", @@ -3456,6 +3460,20 @@ ], "enum": ["BRAINTREE", "PAYPAL", "SDK"] }, + "integration_channel": { + "type": "string", + "description": "The rest api integration channel.", + "minLength": 1, + "maxLength": 128, + "pattern": "^[A-Z0-9_]+$", + "x-enumDescriptions": [ + { + "value": "DEFERRED_ONBOARDING", + "description": "Partners referral merchants onboard with PayPal through the deferred onboarding flow." + } + ], + "enum": ["DEFERRED_ONBOARDING"] + }, "integration_type": { "type": "string", "title": "Integration Type", diff --git a/openapi/invoicing_v2.json b/openapi/invoicing_v2.json index 8b3eba0..e4a6dfd 100644 --- a/openapi/invoicing_v2.json +++ b/openapi/invoicing_v2.json @@ -585,6 +585,21 @@ } } }, + "429": { + "description": "Too many requests. Blocked due to rate limiting.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error_429" + } + }, + "multipart/mixed": { + "schema": { + "$ref": "#/components/schemas/error_429" + } + } + } + }, "500": { "description": "An internal server error has occurred.", "content": { @@ -1640,6 +1655,21 @@ } } }, + "429": { + "description": "Too many requests. Blocked due to rate limiting.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error_429" + } + }, + "multipart/mixed": { + "schema": { + "$ref": "#/components/schemas/error_429" + } + } + } + }, "500": { "description": "An internal server error has occurred.", "content": { @@ -3430,6 +3460,25 @@ } } }, + "error_429": { + "type": "object", + "title": "Too many requests", + "description": "Too many requests. Blocked due to rate limiting.", + "properties": { + "name": { + "type": "string", + "enum": ["RATE_LIMIT_REACHED"] + }, + "message": { + "type": "string", + "enum": ["Too many requests. Blocked due to rate limiting."] + }, + "debug_id": { + "type": "string", + "description": "The PayPal internal ID. Used for correlation purposes." + } + } + }, "error_500": { "type": "object", "title": "Internal Server Error", @@ -3527,6 +3576,9 @@ { "$ref": "#/components/schemas/error_422" }, + { + "$ref": "#/components/schemas/error_429" + }, { "$ref": "#/components/schemas/error_500" }, diff --git a/openapi/notifications_webhooks_v1.json b/openapi/notifications_webhooks_v1.json index f9e8fe1..88d59a8 100644 --- a/openapi/notifications_webhooks_v1.json +++ b/openapi/notifications_webhooks_v1.json @@ -1226,6 +1226,38 @@ "information_link": "https://developer.paypal.com/docs/api/orders/v2/#error-SERVICE_UNAVAILABLE" } }, + "error_default": { + "description": "The default error response.", + "oneOf": [ + { + "$ref": "#/components/schemas/error_400" + }, + { + "$ref": "#/components/schemas/error_401" + }, + { + "$ref": "#/components/schemas/error_403" + }, + { + "$ref": "#/components/schemas/error_404" + }, + { + "$ref": "#/components/schemas/error_409" + }, + { + "$ref": "#/components/schemas/error_415" + }, + { + "$ref": "#/components/schemas/error_422" + }, + { + "$ref": "#/components/schemas/error_500" + }, + { + "$ref": "#/components/schemas/error_503" + } + ] + }, "error_details": { "title": "Error Details", "type": "object", @@ -1319,6 +1351,13 @@ } } }, + "error_list": { + "type": "array", + "description": "An array of webhooks errors.", + "items": { + "$ref": "#/components/schemas/error" + } + }, "error_location": { "type": "string", "description": "The location of the field that caused the error. Value is `body`, `path`, or `query`.", @@ -1348,6 +1387,13 @@ }, "required": ["name"] }, + "error_type_list": { + "type": "array", + "description": "An array of webhooks error types.", + "items": { + "$ref": "#/components/schemas/error_type" + } + }, "event": { "type": "object", "title": "Event", @@ -1618,6 +1664,14 @@ "swagger_link_description": { "$ref": "#/components/schemas/link_description" }, + "swagger_link_description_list": { + "type": "array", + "description": "An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/link_description" + } + }, "verify_webhook_signature": { "type": "object", "title": "Verify Webhook Signature", diff --git a/openapi/payments_payment_v2.json b/openapi/payments_payment_v2.json index a523b97..b954ff8 100644 --- a/openapi/payments_payment_v2.json +++ b/openapi/payments_payment_v2.json @@ -3,7 +3,7 @@ "info": { "title": "Payments", "description": "Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the Orders API. For more information, see the PayPal Checkout Overview.", - "version": "2.8", + "version": "2.9", "contact": {} }, "servers": [ @@ -88,6 +88,23 @@ } } }, + "403": { + "description": "The request failed because the caller has insufficient permissions.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/error_403" + }, + { + "$ref": "#/components/schemas/403" + } + ] + } + } + } + }, "404": { "description": "The request failed because the resource does not exist.", "content": { @@ -376,6 +393,23 @@ } } }, + "403": { + "description": "The request failed because the caller has insufficient permissions.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/error_403" + }, + { + "$ref": "#/components/schemas/403" + } + ] + } + } + } + }, "404": { "description": "The request failed because the resource does not exist.", "content": { @@ -958,11 +992,6 @@ } }, "schemas": { - "2": { - "title": "Capture Request", - "type": "object", - "description": "Captures either a portion or the full authorized amount of an authorized payment." - }, "400": { "properties": { "details": { @@ -1503,7 +1532,7 @@ "maxLength": 255 }, "network_transaction_reference": { - "$ref": "#/components/schemas/network_transaction_reference" + "$ref": "#/components/schemas/network_transaction" }, "seller_protection": { "$ref": "#/components/schemas/seller_protection", @@ -2044,7 +2073,7 @@ "maxLength": 255 }, "network_transaction_reference": { - "$ref": "#/components/schemas/network_transaction_reference" + "$ref": "#/components/schemas/network_transaction" }, "seller_protection": { "$ref": "#/components/schemas/seller_protection", @@ -2123,7 +2152,25 @@ "default": false }, "payment_instruction": { - "$ref": "#/components/schemas/payment_instruction" + "type": "object", + "title": "Payment Instruction", + "description": "Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.", + "properties": { + "platform_fees": { + "$ref": "#/components/schemas/platform_fee_list" + }, + "disbursement_mode": { + "description": "The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.", + "$ref": "#/components/schemas/disbursement_mode" + }, + "payee_receivable_fx_rate_id": { + "type": "string", + "description": "FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.", + "maxLength": 4000, + "minLength": 1, + "pattern": "^.*$" + } + } }, "note_to_payer": { "description": "An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.", @@ -2138,7 +2185,9 @@ } }, { - "$ref": "#/components/schemas/2" + "title": "Capture Request", + "type": "object", + "description": "Captures either a portion or the full authorized amount of an authorized payment." } ] }, @@ -2786,6 +2835,26 @@ "value": "EFTPOS", "description": "The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network." }, + { + "value": "CARTE_BANCAIRE", + "description": "The Carte Bancaire payment network." + }, + { + "value": "STAR_ACCESS", + "description": "The Star Access payment network." + }, + { + "value": "PULSE", + "description": "The Pulse payment network." + }, + { + "value": "NYCE", + "description": "The NYCE payment network." + }, + { + "value": "ACCEL", + "description": "The Accel payment network." + }, { "value": "UNKNOWN", "description": "UNKNOWN payment network." @@ -2816,6 +2885,11 @@ "GE", "SYNCHRONY", "EFTPOS", + "CARTE_BANCAIRE", + "STAR_ACCESS", + "PULSE", + "NYCE", + "ACCEL", "UNKNOWN" ] }, @@ -3372,7 +3446,17 @@ "CONNECT", "OPTIONS", "PATCH" - ] + ], + "x-enumDescriptions": { + "GET": "The HTTP GET method.", + "POST": "The HTTP POST method.", + "PUT": "The HTTP PUT method.", + "DELETE": "The HTTP DELETE method.", + "HEAD": "The HTTP HEAD method.", + "CONNECT": "The HTTP CONNECT method.", + "OPTIONS": "The HTTP OPTIONS method.", + "PATCH": "The HTTP PATCH method." + } } } }, @@ -3431,9 +3515,9 @@ }, "readOnly": true }, - "network_transaction_reference": { + "network_transaction": { "type": "object", - "title": "Network Transaction Reference", + "title": "Network Transaction", "description": "Reference values used by the card network to identify a transaction.", "properties": { "id": { @@ -3461,8 +3545,7 @@ "maxLength": 36, "pattern": "^[a-zA-Z0-9]+$" } - }, - "required": ["id"] + } }, "payee_base": { "type": "object", @@ -3480,27 +3563,6 @@ } }, "payment_instruction": { - "type": "object", - "title": "Payment Instruction", - "description": "Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.", - "properties": { - "platform_fees": { - "$ref": "#/components/schemas/payment_instruction_definition_platform_fee_list" - }, - "disbursement_mode": { - "description": "The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.", - "$ref": "#/components/schemas/disbursement_mode" - }, - "payee_receivable_fx_rate_id": { - "type": "string", - "description": "FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.", - "maxLength": 4000, - "minLength": 1, - "pattern": "^.*$" - } - } - }, - "payment_instruction-2": { "type": "object", "title": "Refund Payment Instruction", "description": "Any additional payments instructions during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability.", @@ -3510,15 +3572,6 @@ } } }, - "payment_instruction_definition_platform_fee_list": { - "type": "array", - "description": "An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.", - "minItems": 0, - "maxItems": 1, - "items": { - "$ref": "#/components/schemas/platform_fee" - } - }, "platform_fee": { "type": "object", "title": "Platform Fee", @@ -4736,7 +4789,7 @@ }, "payment_instruction": { "description": "Any additional refund instructions to be set during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability.", - "$ref": "#/components/schemas/payment_instruction-2" + "$ref": "#/components/schemas/payment_instruction" } } }, diff --git a/openapi/shipping_shipment_tracking_v1.json b/openapi/shipping_shipment_tracking_v1.json index c86655c..c9cffb6 100644 --- a/openapi/shipping_shipment_tracking_v1.json +++ b/openapi/shipping_shipment_tracking_v1.json @@ -3,7 +3,7 @@ "info": { "title": "Shipment Tracking", "description": "Merchants can use the PayPal Add Tracking API to manage tracking information. Merchants can add tracking numbers and associated information to PayPal. There are 2 ways in which tracking details can be shared to PayPal.\nIf you have a legacy integration that doesn't use the Orders v2 API, share tracking details through the Add Shipping Tracking API. If you are using the Orders v2 API, share tracking details through the Orders v2 API.After adding these details to PayPal, merchants can:For more information, see the Add Tracking API Overview and Add Tracking API Integration Guide.", - "version": "1.9", + "version": "1.10", "contact": {} }, "servers": [ @@ -31,7 +31,7 @@ }, { "name": "carriers", - "description": "Use the `/carriers` resource to list/detect all the carriers available for tracking in PayPal and its subsidiary." + "description": "Use the `/carriers` resource to create and list/detect all the carriers available for tracking in PayPal and its subsidiary." }, { "name": "shipments", @@ -200,4207 +200,193 @@ "/v1/shipping/trackers/{id}": { "put": { "summary": "Update or cancel tracking information for PayPal transaction", - "description": "Updates or cancels the tracking information for a PayPal transaction, by ID. To cancel tracking information, call this method and set the status to CANCELLED. For more information, see Update or cancel tracking information.", + "description": "Updates or cancels the tracking information for a PayPal transaction, by ID. To cancel tracking information, call this method and set the status to CANCELLED. A maximum of 5 updates are allowed for each tracking information. For more information, see Update or cancel tracking information.", "operationId": "trackers.put", "responses": { "204": { "description": "A successful request returns the HTTP 204 OK status code with no JSON response body." }, - "default": { - "description": "The error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/id" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tracker" - } - } - } - }, - "security": [ - { - "Oauth2": [ - "https://uri.paypal.com/services/shipping/trackers/readwrite" - ] - } - ], - "tags": ["trackers"] - }, - "get": { - "summary": "Show tracking information", - "description": "Shows tracking information, by tracker ID, for a PayPal transaction.", - "operationId": "trackers.get", - "responses": { - "200": { - "description": "A successful request returns the HTTP `200 OK` status code and a JSON response body that shows tracking information.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tracker" - } - } - } - }, - "default": { - "description": "The error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/id" - }, - { - "$ref": "#/components/parameters/account_id" - } - ], - "security": [ - { - "Oauth2": [ - "https://uri.paypal.com/services/shipping/trackers/read", - "https://uri.paypal.com/services/shipping/trackers/readwrite" - ] - } - ], - "tags": ["trackers"] - } - } - }, - "components": { - "requestBodies": { - "tracker_collection": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tracker_collection" - } - } - } - } - }, - "securitySchemes": { - "Oauth2": { - "type": "oauth2", - "description": "Oauth 2.0 authentication", - "flows": { - "clientCredentials": { - "tokenUrl": "/v1/oauth2/token", - "scopes": { - "https://uri.paypal.com/services/shipping/trackers/readwrite": "Create or update tracking information", - "https://uri.paypal.com/services/shipping/trackers/read": "Retrieve tracking information" - } - } - } - } - }, - "schemas": { - "batch_tracker_collection": { - "type": "object", - "title": "Batch Tracker Collection", - "description": "The add tracking information for multiple PayPal transactions response details.", - "properties": { - "tracker_identifiers": { - "$ref": "#/components/schemas/tracker_identifier_list" - }, - "errors": { - "$ref": "#/components/schemas/error_list" - }, - "links": { - "$ref": "#/components/schemas/batch_tracker_collection_definitions-link_description_list" - } - } - }, - "batch_tracker_collection_definitions-link_description_list": { - "type": "array", - "description": "An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/link_description" - }, - "minItems": 1, - "maxItems": 1 - }, - "carrier": { - "type": "string", - "title": "Carrier", - "description": "The carrier for the shipment. Carrier information is required when tracking_number is provided. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set `carrier` to `OTHER` and set carrier name in `carrier_name_other`. For allowed values, see Carriers.", - "minLength": 1, - "maxLength": 64, - "pattern": "^.*$", - "x-enumDescriptions": [ - { - "value": "2EBOX", - "description": "2ebox courier." - }, - { - "value": "360LION", - "description": "360 Lion Express." - }, - { - "value": "3JMSLOGISTICS", - "description": "3JMS Logistics." - }, - { - "value": "4_72", - "description": "4-72 Entregando" - }, - { - "value": "6LS", - "description": "6ls.com." - }, - { - "value": "A1POST", - "description": "A1Post." - }, - { - "value": "AAA_COOPER", - "description": "AAA Cooper." - }, - { - "value": "ABCUSTOM", - "description": "AB Custom Group." - }, - { - "value": "ABXEXPRESS_MY", - "description": "ABX Express." - }, - { - "value": "ACOMMMERCE", - "description": "aCommerce." - }, - { - "value": "ACSWORLDWIDE", - "description": "ACS Worldwide Express." - }, - { - "value": "ACS_GR", - "description": "ACS Courier." - }, - { - "value": "ADERONLINE", - "description": "Ader couriers." - }, - { - "value": "ADICIONAL", - "description": "Adicional Logistics." - }, - { - "value": "ADSONE", - "description": "ADSone." - }, - { - "value": "ADUIEPYLE", - "description": "A Duie Pyle." - }, - { - "value": "AERONET", - "description": "Aeronet couriers." - }, - { - "value": "AEX", - "description": "AEX Group." - }, - { - "value": "AFLLOG_FTP", - "description": "AFL LOGISTICS." - }, - { - "value": "AGILITY", - "description": "Agility." - }, - { - "value": "AIRMEE_WEBHOOK", - "description": "Airmee couriers." - }, - { - "value": "AIR_CANADA_GLOBAL", - "description": "Rivo (Air canada)." - }, - { - "value": "ALFATREX", - "description": "AlfaTrex." - }, - { - "value": "ALLIEDEXPRESS", - "description": "Allied Express." - }, - { - "value": "ALLJOY", - "description": "ALLJOY SUPPLY CHAIN." - }, - { - "value": "ALPHAFAST", - "description": "Alphafast (www.alphafast.com)." - }, - { - "value": "ALWAYS_EXPRESS", - "description": "Always Express." - }, - { - "value": "AMAZON", - "description": "Amazon Shipping." - }, - { - "value": "AMAZON_FBA_SWISHIP", - "description": "Swiship UK." - }, - { - "value": "AMAZON_SHIP_MCF", - "description": "Amazon Shipping + Amazon MCF." - }, - { - "value": "AMSTAN", - "description": "Amstan Logistics." - }, - { - "value": "AMS_GRP", - "description": "AMS Group." - }, - { - "value": "ANDREANI", - "description": "Grupo logistico Andreani." - }, - { - "value": "ANICAM_BOX", - "description": "ANICAM BOX EXPRESS." - }, - { - "value": "ANJUN", - "description": "Anjun couriers." - }, - { - "value": "ANSERX", - "description": "ANSERX courier." - }, - { - "value": "AN_POST", - "description": "An Post." - }, - { - "value": "AO_COURIER", - "description": "AO Logistics." - }, - { - "value": "AO_DEUTSCHLAND", - "description": "AO Deutschland." - }, - { - "value": "APC_OVERNIGHT", - "description": "APC overnight (apc-overnight.com)." - }, - { - "value": "APC_OVERNIGHT_CONNUM", - "description": "APC Overnight Consignment." - }, - { - "value": "APG", - "description": "APG eCommerce Solutions." - }, - { - "value": "APRISAEXPRESS", - "description": "Aprisa Express." - }, - { - "value": "AQUILINE", - "description": "Aquiline." - }, - { - "value": "ARAMEX", - "description": "Aramex." - }, - { - "value": "ARAMEX_AU", - "description": "Aramex Australia (formerly Fastway AU)." - }, - { - "value": "ARCO_SPEDIZIONI", - "description": "Arco Spedizioni SP." - }, - { - "value": "ARE_EMIRATES_POST", - "description": "Emirates Post." - }, - { - "value": "ARG_OCA", - "description": "OCA Argentina." - }, - { - "value": "ARK_LOGISTICS", - "description": "ARK Logistics." - }, - { - "value": "ASE", - "description": "ASE KARGO." - }, - { - "value": "ASENDIA_HK", - "description": "Asendia HonKong." - }, - { - "value": "ASENDIA_UK", - "description": "Asendia UK." - }, - { - "value": "ASENDIA_USA", - "description": "Asendia USA." - }, - { - "value": "ASIGNA", - "description": "ASIGNA courier." - }, - { - "value": "AUPOST_CN", - "description": "AuPost China." - }, - { - "value": "AUSTRIAN_POST_EXPRESS", - "description": "austrian post." - }, - { - "value": "AUS_STARTRACK", - "description": "StarTrack (startrack.com.au)." - }, - { - "value": "AUS_TOLL", - "description": "TOLL Australia." - }, - { - "value": "AU_AUSTRIAN_POST", - "description": "Austrian Post (Registered)." - }, - { - "value": "AU_AU_POST", - "description": "Australia Post." - }, - { - "value": "AU_TNT", - "description": "TNT Australia." - }, - { - "value": "AVERITT", - "description": "Averitt Express." - }, - { - "value": "BEL_DHL", - "description": "DHL Benelux." - }, - { - "value": "BEL_RS", - "description": "BEL North Russia." - }, - { - "value": "BESTWAYPARCEL", - "description": "Best Way Parcel." - }, - { - "value": "BE_BPOST", - "description": "Bpost (www.bpost.be)." - }, - { - "value": "BE_KIALA", - "description": "Kiala." - }, - { - "value": "BG_BULGARIAN_POST", - "description": "Bulgarian Posts." - }, - { - "value": "BH_POSTA", - "description": "BH Posta (www.posta.ba)." - }, - { - "value": "BH_WORLDWIDE", - "description": "B&H Worldwide." - }, - { - "value": "BIRDSYSTEM", - "description": "BirdSystem." - }, - { - "value": "BJSHOMEDELIVERY", - "description": "BJS Distribution courier." - }, - { - "value": "BLINKLASTMILE", - "description": "Blink." - }, - { - "value": "BLR_BELPOST", - "description": "Belpost." - }, - { - "value": "BLUECARE", - "description": "Bluecare Express Ltd." - }, - { - "value": "BLUESTAR", - "description": "Blue Star." - }, - { - "value": "BLUEX", - "description": "Blue Express." - }, - { - "value": "BNEED", - "description": "Bneed courier." - }, - { - "value": "BOMBINOEXP", - "description": "Bombino Express Pvt." - }, - { - "value": "BOND", - "description": "Bond courier." - }, - { - "value": "BONDSCOURIERS", - "description": "Bonds Courier Service (bondscouriers.com.au)." - }, - { - "value": "BORDEREXPRESS", - "description": "Border Express." - }, - { - "value": "BOX_BERRY", - "description": "Boxberry courier." - }, - { - "value": "BPOST_INT", - "description": "Bpost international." - }, - { - "value": "BRA_CORREIOS", - "description": "Correios Brazil." - }, - { - "value": "BRING", - "description": "Bring." - }, - { - "value": "BROUWER_TRANSPORT", - "description": "Brouwer Transport en Logistiek." - }, - { - "value": "BRT_IT", - "description": "BRT couriers Italy (www.brt.it)." - }, - { - "value": "BRT_IT_PARCELID", - "description": "BRT Bartolini(Parcel ID)." - }, - { - "value": "BRT_IT_SENDER_REF", - "description": "BRT Bartolini(Sender Reference)." - }, - { - "value": "BUDBEE_WEBHOOK", - "description": "Budbee courier." - }, - { - "value": "BUYLOGIC", - "description": "buylogic." - }, - { - "value": "B_TWO_C_EUROPE", - "description": "B2C courier Europe." - }, - { - "value": "CAE_DELIVERS", - "description": "CAE Delivers." - }, - { - "value": "CAINIAO", - "description": "AliExpress Standard Shipping." - }, - { - "value": "CARIBOU", - "description": "Caribou." - }, - { - "value": "CARRIERS", - "description": "Carriers courier." - }, - { - "value": "CARRY_FLAP", - "description": "Carry-Flap Co.." - }, - { - "value": "CA_CANADA_POST", - "description": "Canada Post." - }, - { - "value": "CA_CANPAR", - "description": "Canpar Courier." - }, - { - "value": "CA_GREYHOUND", - "description": "Greyhound." - }, - { - "value": "CA_PUROLATOR", - "description": "Purolator." - }, - { - "value": "CBL_LOGISTICA", - "description": "CBL Logistica." - }, - { - "value": "CDEK", - "description": "CDEK courier." - }, - { - "value": "CDEK_TR", - "description": "CDEK TR." - }, - { - "value": "CELERITAS", - "description": "Celeritas Transporte." - }, - { - "value": "CELLO_SQUARE", - "description": "Cello Square." - }, - { - "value": "CESKA_CZ", - "description": "Czech Post." - }, - { - "value": "CEVA", - "description": "CEVA LOGISTICS." - }, - { - "value": "CFL_LOGISTICS", - "description": "CFL Logistics." - }, - { - "value": "CGS_EXPRESS", - "description": "CGS Express." - }, - { - "value": "CHAMPION_LOGISTICS", - "description": "Champion Logistics." - }, - { - "value": "CHITCHATS", - "description": "Chit Chats." - }, - { - "value": "CHOIR_EXP", - "description": "Choir Express Indonesia." - }, - { - "value": "CHROBINSON", - "description": "C.H. Robinson Worldwide." - }, - { - "value": "CHRONOPOST_FR", - "description": "Chronopost france (www.chronopost.fr)." - }, - { - "value": "CHUKOU1", - "description": "Chukou1." - }, - { - "value": "CH_SWISS_POST_PRIORITY", - "description": "Swiss Post." - }, - { - "value": "CITYLINK_MY", - "description": "City-Link Express." - }, - { - "value": "CJPACKET", - "description": "CJ Packet." - }, - { - "value": "CJ_CENTURY", - "description": "CJ Century." - }, - { - "value": "CJ_GLS", - "description": "CJ GLS." - }, - { - "value": "CJ_HK_INTERNATIONAL", - "description": "CJ Logistics International(Hong Kong)." - }, - { - "value": "CJ_INT_MY", - "description": "CJ International malaysia." - }, - { - "value": "CJ_KR", - "description": "CJ Korea Express." - }, - { - "value": "CJ_LOGISTICS", - "description": "CJ Logistics International." - }, - { - "value": "CJ_TH", - "description": "CJ Transnational Philippines." - }, - { - "value": "CLEVY_LINKS", - "description": "Clevy Links." - }, - { - "value": "CLE_LOGISTICS", - "description": "CL E-Logistics Solutions Limited." - }, - { - "value": "CLOUDWISH_ASIA", - "description": "Cloudwish Asia." - }, - { - "value": "CNDEXPRESS", - "description": "CND Express." - }, - { - "value": "CNEXPS", - "description": "CNE Express." - }, - { - "value": "CNWANGTONG", - "description": "cnwangtong." - }, - { - "value": "CN_17POST", - "description": "17 Post Service." - }, - { - "value": "CN_BESTEXPRESS", - "description": "Best Express." - }, - { - "value": "CN_BOXC", - "description": "BoxC courier." - }, - { - "value": "CN_CHINA_POST_EMS", - "description": "China Post." - }, - { - "value": "CN_DPEX", - "description": "DPEX." - }, - { - "value": "CN_EMS", - "description": "EMS China (www.ems.post)." - }, - { - "value": "CN_EQUICK", - "description": "Equick China." - }, - { - "value": "CN_JCEX", - "description": "JCEX courier." - }, - { - "value": "CN_PAYPAL_PACKAGE", - "description": "PayPal Package." - }, - { - "value": "CN_POST56", - "description": "Post56." - }, - { - "value": "CN_SF_EXPRESS", - "description": "SF Express (www.sf-express.com)." - }, - { - "value": "CN_STO", - "description": "STO Express." - }, - { - "value": "CN_WEDO", - "description": "WeDo Logistics." - }, - { - "value": "CN_WISHPOST", - "description": "WishPost." - }, - { - "value": "CN_YUNDA", - "description": "Yunda Express." - }, - { - "value": "COLIS_PRIVE", - "description": "Colis Privé." - }, - { - "value": "COLLECTCO", - "description": "CollectCo." - }, - { - "value": "COLLIVERY", - "description": "MDS Collivery Pty (Ltd)." - }, - { - "value": "COMET_TECH", - "description": "CometTech." - }, - { - "value": "CONTINENTAL", - "description": "Continental." - }, - { - "value": "CON_WAY", - "description": "Con-way Freight." - }, - { - "value": "COORDINADORA", - "description": "Coordinadora." - }, - { - "value": "COPA_COURIER", - "description": "Copa Airlines Courier." - }, - { - "value": "COPE", - "description": "Cope Sensitive Freight." - }, - { - "value": "CORPORATECOURIERS_WEBHOOK", - "description": "Corporate Couriers." - }, - { - "value": "CORREOS_DE_MEXICO", - "description": "correos mexico." - }, - { - "value": "CORREOS_ES", - "description": "correos Express (www.correos.es)." - }, - { - "value": "CORREOS_EXPRESS", - "description": "Correos Express." - }, - { - "value": "CORREO_UY", - "description": "Correo Uruguayo." - }, - { - "value": "COSTMETICSNOW", - "description": "Cosmetics Now." - }, - { - "value": "COURANT_PLUS", - "description": "Courant Plus." - }, - { - "value": "COUREX", - "description": "Urbanfox." - }, - { - "value": "COURIERS_PLEASE", - "description": "CouriersPlease (couriersplease.com.au)." - }, - { - "value": "CPACKET", - "description": "Cpacket couriers." - }, - { - "value": "CPEX", - "description": "Captain Express International." - }, - { - "value": "CROSHOT", - "description": "Croshot." - }, - { - "value": "CSE", - "description": "CSE courier." - }, - { - "value": "CTC_EXPRESS", - "description": "CTC Express." - }, - { - "value": "CUBYN", - "description": "Cubyn." - }, - { - "value": "CUCKOOEXPRESS", - "description": "Cuckoo Express." - }, - { - "value": "CYPRUS_POST_CYP", - "description": "cyprus post." - }, - { - "value": "DAIGLOBALTRACK", - "description": "DAI Post." - }, - { - "value": "DAJIN", - "description": "Shanghai Aqrum Chemical Logistics Co.Ltd." - }, - { - "value": "DANSKE_FRAGT", - "description": "Danske Fragtaend." - }, - { - "value": "DAWN_WING", - "description": "Dawn Wing." - }, - { - "value": "DAYTON_FREIGHT", - "description": "Dayton Freight." - }, - { - "value": "DBSCHENKER_B2B", - "description": "DB Schenker B2B." - }, - { - "value": "DBSCHENKER_SE", - "description": "DB Schenker (www.dbschenker.com)." - }, - { - "value": "DBSCHENKER_SV", - "description": "DB Schenker Sweden." - }, - { - "value": "DDEXPRESS", - "description": "DD Express Courier." - }, - { - "value": "DEALERSEND", - "description": "DealerSend." - }, - { - "value": "DELIVERYONTIME", - "description": "DELIVERYONTIME LOGISTICS PVT LTD." - }, - { - "value": "DELNEXT", - "description": "Delnext." - }, - { - "value": "DELTEC_UK", - "description": "Deltec Courier." - }, - { - "value": "DEMANDSHIP", - "description": "DemandShip." - }, - { - "value": "DESCARTES", - "description": "Innovel courier." - }, - { - "value": "DESIGNERTRANSPORT_WEBHOOK", - "description": "Designer Transport." - }, - { - "value": "DESTINY", - "description": "Destiny Transportation." - }, - { - "value": "DEX_I", - "description": "DEX-I courier." - }, - { - "value": "DE_ASENDIA", - "description": "Asendia Germany." - }, - { - "value": "DE_DEUTSCHE", - "description": "Deutsche post." - }, - { - "value": "DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET", - "description": "Deutsche Post DHL." - }, - { - "value": "DE_DHL_EXPRESS", - "description": "DHL Express." - }, - { - "value": "DE_DPD_DELISTRACK", - "description": "DPD Germany." - }, - { - "value": "DE_GLS", - "description": "GLS parcel services (www.gls-group.eu)." - }, - { - "value": "DHL", - "description": "dhl Global." - }, - { - "value": "DHL_ACTIVE_TRACING", - "description": "DHL Active Tracing." - }, - { - "value": "DHL_AU", - "description": "DHL Supply Chain Australia." - }, - { - "value": "DHL_BENELUX", - "description": "dhl benelux." - }, - { - "value": "DHL_ECOMERCE_ASA", - "description": "DHL eCommerce Asia (API)." - }, - { - "value": "DHL_ES", - "description": "DHL Spain(www.dhl.com)." - }, - { - "value": "DHL_FR", - "description": "DHL France (www.dhl.com)." - }, - { - "value": "DHL_FREIGHT", - "description": "DHL Freight." - }, - { - "value": "DHL_GLOBAL_MAIL_ASIA", - "description": "DHL Global Mail Asia (www.dhl.com)." - }, - { - "value": "DHL_HK", - "description": "DHL HonKong." - }, - { - "value": "DHL_JP", - "description": "DHL Japan." - }, - { - "value": "DHL_PARCEL_ES", - "description": "DHL parcel Spain(www.dhl.com)." - }, - { - "value": "DHL_PARCEL_NL", - "description": "DHL Parcel NL." - }, - { - "value": "DHL_PARCEL_RU", - "description": "DHL Parcel Russia." - }, - { - "value": "DHL_PL", - "description": "DHL Poland." - }, - { - "value": "DHL_REFR", - "description": "DHl (Reference number)." - }, - { - "value": "DHL_SG", - "description": "dhl Singapore." - }, - { - "value": "DHL_SUPPLY_CHAIN", - "description": "DHL Supply Chain APAC." - }, - { - "value": "DHL_UK", - "description": "dhl UK." - }, - { - "value": "DIAMOND_EUROGISTICS", - "description": "Diamond Eurogistics Limited." - }, - { - "value": "DICOM", - "description": "GLS Logistic Systems Canada Ltd./Dicom." - }, - { - "value": "DIDADI", - "description": "DIDADI Logistics tech." - }, - { - "value": "DIMERCO", - "description": "Dimerco Express Group." - }, - { - "value": "DIRECTCOURIERS", - "description": "Direct Couriers." - }, - { - "value": "DIRECTLOG", - "description": "Directlog (www.directlog.com.br)." - }, - { - "value": "DIRECTPARCELS", - "description": "Direct Parcels." - }, - { - "value": "DMM_NETWORK", - "description": "DMM Network." - }, - { - "value": "DMS_MATRIX", - "description": "DMSMatrix." - }, - { - "value": "DOBROPOST", - "description": "DobroPost." - }, - { - "value": "DOORA", - "description": "Doora Logistics." - }, - { - "value": "DOORDASH_WEBHOOK", - "description": "DoorDash." - }, - { - "value": "DPD", - "description": "DPD." - }, - { - "value": "DPD_DELISTRACK", - "description": "DPD delistrack." - }, - { - "value": "DPD_FR", - "description": "DPD France." - }, - { - "value": "DPD_HGRY", - "description": "DPD Hungary." - }, - { - "value": "DPD_HK", - "description": "DPD HongKong." - }, - { - "value": "DPD_IR", - "description": "DPD Ireland." - }, - { - "value": "DPD_LOCAL", - "description": "DPD Local." - }, - { - "value": "DPD_LOCAL_REF", - "description": "DPD Local reference." - }, - { - "value": "DPD_POLAND", - "description": "DPD Poland." - }, - { - "value": "DPD_RO", - "description": "DPD Romania." - }, - { - "value": "DPD_RU", - "description": "DPD Russia." - }, - { - "value": "DPEX", - "description": "DPEX (www.dpex.com)." - }, - { - "value": "DPE_EXPRESS", - "description": "DPE Express." - }, - { - "value": "DPE_SOUTH_AFRC", - "description": "DPE South Africa." - }, - { - "value": "DSV", - "description": "DSV courier." - }, - { - "value": "DTDC_AU", - "description": "DTDC Australia." - }, - { - "value": "DTDC_EXPRESS", - "description": "DTDC express." - }, - { - "value": "DTDC_IN", - "description": "DTDC India." - }, - { - "value": "DTD_EXPR", - "description": "DTD Express." - }, - { - "value": "DX_SFTP", - "description": "DX (SFTP)." - }, - { - "value": "DYLT", - "description": "Daylight Transport." - }, - { - "value": "DYNALOGIC", - "description": "Dynamic Logistics." - }, - { - "value": "EASY_MAIL", - "description": "Easy Mail." - }, - { - "value": "ECEXPRESS", - "description": "ECexpress." - }, - { - "value": "ECHO", - "description": "Echo courier." - }, - { - "value": "ECMS", - "description": "ECMS International Logistics Co.." - }, - { - "value": "ECOSCOOTING", - "description": "ECOSCOOTING." - }, - { - "value": "EFEX", - "description": "eFEx (E-Commerce Fulfillment & Express)." - }, - { - "value": "EFS", - "description": "EFS (E-commerce Fulfillment Service)." - }, - { - "value": "EKART", - "description": "Ekart logistics (ekartlogistics.com)." - }, - { - "value": "ELIAN_POST", - "description": "Yilian (Elian) Supply Chain." - }, - { - "value": "EMPS_CN", - "description": "EMPS Express." - }, - { - "value": "ENDEAVOUR_DELIVERY", - "description": "Endeavour Delivery." - }, - { - "value": "ENVIALIA_REFERENCE", - "description": "Envialia Reference." - }, - { - "value": "EPARCEL_KR", - "description": "eParcel Korea." - }, - { - "value": "EPST_GLBL", - "description": "ePost Global" - }, - { - "value": "EP_BOX", - "description": "EP-Box courier." - }, - { - "value": "ESHIPPING", - "description": "Eshipping." - }, - { - "value": "ESP_ASM", - "description": "ASM(GLS Spain)." - }, - { - "value": "ESP_ENVIALIA", - "description": "Envialia." - }, - { - "value": "ESP_MRW", - "description": "MRW spain." - }, - { - "value": "ESP_NACEX", - "description": "NACEX Spain." - }, - { - "value": "ESP_PACKLINK", - "description": "Packlink." - }, - { - "value": "ESP_REDUR", - "description": "Redur Spain." - }, - { - "value": "ETOMARS", - "description": "Etomars." - }, - { - "value": "ETOTAL", - "description": "eTotal Solution Limited." - }, - { - "value": "ETS_EXPRESS", - "description": "RETS express." - }, - { - "value": "EU_FLEET_SOLUTIONS", - "description": "EU Fleet Solutions." - }, - { - "value": "EU_IMX", - "description": "IMX Mail." - }, - { - "value": "EXPRESSSALE", - "description": "Expresssale." - }, - { - "value": "FARGOOD", - "description": "FarGood." - }, - { - "value": "FAR_INTERNATIONAL", - "description": "FAR international." - }, - { - "value": "FASTRACK", - "description": "Fasttrack." - }, - { - "value": "FASTRK_SERV", - "description": "Fastrak Services." - }, - { - "value": "FASTWAY_IR", - "description": "Fastway Ireland." - }, - { - "value": "FASTWAY_NZ", - "description": "Fastway New Zealand." - }, - { - "value": "FDSEXPRESS", - "description": "FDSEXPRESS." - }, - { - "value": "FEDEX", - "description": "Fedex." - }, - { - "value": "FEDEX_CROSSBORDER", - "description": "FedEx Cross Border." - }, - { - "value": "FEDEX_FR", - "description": "FedEx® Freight." - }, - { - "value": "FEDEX_INTL_MLSERV", - "description": "FedEx International MailService." - }, - { - "value": "FEDEX_POLAND", - "description": "FedEx® Poland Domestic." - }, - { - "value": "FEDEX_UK", - "description": "FedEx® UK." - }, - { - "value": "FETCHR_WEBHOOK", - "description": "Mena 360 (Fetchr)." - }, - { - "value": "FIEGE", - "description": "Fiege Logistics." - }, - { - "value": "FIEGE_NL", - "description": "Fiege Netherlands." - }, - { - "value": "FIRSTMILE", - "description": "FirstMile." - }, - { - "value": "FLASHEXPRESS", - "description": "Flash Express." - }, - { - "value": "FMX", - "description": "FMX." - }, - { - "value": "FONSEN", - "description": "Fonsen Logistics." - }, - { - "value": "FORRUN", - "description": "forrun Pvt Ltd (Arpatech Venture)." - }, - { - "value": "FREIGHTQUOTE", - "description": "Freightquote by C.H. Robinson." - }, - { - "value": "FRETERAPIDO", - "description": "Frete Rapido." - }, - { - "value": "FR_BERT", - "description": "Bert Transport." - }, - { - "value": "FR_COLIS", - "description": "Colissimo." - }, - { - "value": "FR_EXAPAQ", - "description": "DPD France (formerly exapaq)." - }, - { - "value": "FR_GEODIS", - "description": "GEODIS - Distribution & Express." - }, - { - "value": "FR_GLS", - "description": "GLS france." - }, - { - "value": "FULFILLA", - "description": "Fulfilla." - }, - { - "value": "FULFILLME", - "description": "Fulfillme." - }, - { - "value": "FURDECO", - "description": "Furdeco." - }, - { - "value": "GAC", - "description": "GAC." - }, - { - "value": "GANGBAO", - "description": "GANGBAO Supplychain." - }, - { - "value": "GBA", - "description": "GBA Services Ltd." - }, - { - "value": "GBS_BROKER", - "description": "GBS-Broker." - }, - { - "value": "GB_APC", - "description": "APC postal logistics germany." - }, - { - "value": "GB_ARROW", - "description": "Arrow XL." - }, - { - "value": "GB_NORSK", - "description": "Norsk Global." - }, - { - "value": "GB_PANTHER", - "description": "Panther." - }, - { - "value": "GB_TUFFNELLS", - "description": "Tuffnells Parcels Express." - }, - { - "value": "GEIS", - "description": "Geis CZ." - }, - { - "value": "GEL_EXPRESS", - "description": "Gel Express Logistik." - }, - { - "value": "GEMWORLDWIDE", - "description": "GEM Worldwide." - }, - { - "value": "GENERAL_OVERNIGHT", - "description": "Go!Express and logistics." - }, - { - "value": "GENIKI_GR", - "description": "Geniki Taxydromiki." - }, - { - "value": "GEODIS_ESPACE", - "description": "Geodis E-space." - }, - { - "value": "GESWL", - "description": "GESWL Express." - }, - { - "value": "GIAO_HANG", - "description": "Giao hàng nhanh." - }, - { - "value": "GIO_EXPRESS", - "description": "Gio Express." - }, - { - "value": "GLOBALTRANZ", - "description": "GlobalTranz." - }, - { - "value": "GLOBAL_ABF", - "description": "ABF Freight." - }, - { - "value": "GLOBAL_ESTES", - "description": "Estes Express Lines." - }, - { - "value": "GLOBAL_EXPRESS", - "description": "Tai Wan Global Business." - }, - { - "value": "GLOBAL_IPARCEL", - "description": "i-parcel." - }, - { - "value": "GLOBAL_TNT", - "description": "TNT global." - }, - { - "value": "GLOBAVEND", - "description": "Globavend." - }, - { - "value": "GLS_CROTIA", - "description": "GLS Croatia." - }, - { - "value": "GLS_CZ", - "description": "GLS Czech Republic." - }, - { - "value": "GLS_IT", - "description": "GLS Italy." - }, - { - "value": "GLS_ITALY", - "description": "GLS Italy." - }, - { - "value": "GLS_SLOV", - "description": "GLS General Logistics Systems Slovakia s.r.o.." - }, - { - "value": "GLS_SLOVEN", - "description": "GLS Slovenia." - }, - { - "value": "GOGLOBALPOST", - "description": "Global Post." - }, - { - "value": "GOJEK", - "description": "Gojek." - }, - { - "value": "GRAB_WEBHOOK", - "description": "Grab courier." - }, - { - "value": "GRUPO", - "description": "Grupo ampm." - }, - { - "value": "GR_ELTA", - "description": "ELTA Hellenic Post." - }, - { - "value": "GSI_EXPRESS", - "description": "GSI EXPRESS." - }, - { - "value": "GSO", - "description": "GSO(GLS-USA)." - }, - { - "value": "HAPPY2POINT", - "description": "Happy 2ThePoint" - }, - { - "value": "HCT_LOGISTICS", - "description": "HCT LOGISTICS CO.LTD.." - }, - { - "value": "HDB", - "description": "Haidaibao." - }, - { - "value": "HDB_BOX", - "description": "Haidaibao (BOX)." - }, - { - "value": "HELLMANN", - "description": "Hellmann Worldwide Logistics." - }, - { - "value": "HELTHJEM", - "description": "Helthjem." - }, - { - "value": "HEPPNER", - "description": "Heppner Internationale Spedition GmbH & Co.." - }, - { - "value": "HEPPNER_FR", - "description": "Heppner France." - }, - { - "value": "HERMES", - "description": "HermesWorld UK." - }, - { - "value": "HERMES_2MANN_HANDLING", - "description": "Hermes Einrichtungs Service GmbH & Co. KG." - }, - { - "value": "HERMES_DE", - "description": "Hermes Germany." - }, - { - "value": "HH_EXP", - "description": "Hua Han Logistics." - }, - { - "value": "HIPSHIPPER", - "description": "Hipshipper." - }, - { - "value": "HKD", - "description": "Qingdao HKD International Logistics." - }, - { - "value": "HK_FLYT_EXPRESS", - "description": "FLYT express." - }, - { - "value": "HK_FOUR_PX_EXPRESS", - "description": "4PX (fourPX)." - }, - { - "value": "HK_POST", - "description": "Hongkong Post (www.hongkongpost.hk)." - }, - { - "value": "HK_TGX", - "description": "Kerry Express Hong Kong." - }, - { - "value": "HOLISOL", - "description": "Holisol." - }, - { - "value": "HOME_DELIVERY_SOLUTIONS", - "description": "Home Delivery Solutions Ltd." - }, - { - "value": "HOUNDEXPRESS", - "description": "Hound Express." - }, - { - "value": "HRPARCEL", - "description": "HR Parcel." - }, - { - "value": "HRV_HRVATSKA", - "description": "Hrvatska posta." - }, - { - "value": "HUAHAN_EXPRESS", - "description": "HUAHANG EXPRESS." - }, - { - "value": "HUNTER_EXPRESS", - "description": "Hunter Express." - }, - { - "value": "HUODULL", - "description": "Huodull." - }, - { - "value": "HX_EXPRESS", - "description": "HX Express." - }, - { - "value": "IBEONE", - "description": "Beone Logistics." - }, - { - "value": "ICUMULUS", - "description": "iCumulus." - }, - { - "value": "IDEXPRESS", - "description": "IDEX courier." - }, - { - "value": "IDN_JNE", - "description": "JNE Express (Jalur Nugraha Ekakurir)." - }, - { - "value": "IDN_LION_PARCEL", - "description": "Lion Parcel." - }, - { - "value": "IDN_PANDU", - "description": "pandu Logistics (pandulogistics.com)." - }, - { - "value": "IML", - "description": "IML courier." - }, - { - "value": "INDOPAKET", - "description": "INDOPAKET." - }, - { - "value": "IND_BLUEDART", - "description": "Bluedart." - }, - { - "value": "IND_DELHIVERY", - "description": "Delhivery India." - }, - { - "value": "IND_DELIVREE", - "description": "deliverE." - }, - { - "value": "IND_DOTZOT", - "description": "Dotzot." - }, - { - "value": "IND_ECOM", - "description": "Ecom Express." - }, - { - "value": "IND_FIRSTFLIGHT", - "description": "First Flight Couriers." - }, - { - "value": "IND_GATI", - "description": "Gati-KWE." - }, - { - "value": "IND_GOJAVAS", - "description": "GoJavas." - }, - { - "value": "IND_PROFESSIONAL_COURIERS", - "description": "Professional Couriers." - }, - { - "value": "IND_SAFEEXPRESS", - "description": "Safexpress." - }, - { - "value": "IND_XPRESSBEES", - "description": "Xpressbees (www.xpressbees.com)." - }, - { - "value": "INPOST_PACZKOMATY", - "description": "InPost Paczkomaty." - }, - { - "value": "INTEGRA2_FTP", - "description": "Integra2." - }, - { - "value": "INTELIPOST", - "description": "Intelipost (TMS for LATAM)." - }, - { - "value": "INTEL_VALLEY", - "description": "Intel-Valley Supply chain (ShenZhen) Co. Ltd." - }, - { - "value": "INTERPARCEL_AU", - "description": "Interparcel Australia." - }, - { - "value": "INTERPARCEL_NZ", - "description": "Interparcel New Zealand." - }, - { - "value": "INTERPARCEL_UK", - "description": "Interparcel UK." - }, - { - "value": "INTEXPRESS", - "description": "Internet Express." - }, - { - "value": "ISRAEL_POST", - "description": "Israel Post." - }, - { - "value": "ISR_POST_DOMESTIC", - "description": "Israel Post Domestic." - }, - { - "value": "IT_DHL_ECOMMERCE", - "description": "DHL International." - }, - { - "value": "IT_FERCAM", - "description": "FERCAM Logistics & Transport." - }, - { - "value": "IT_NEXIVE", - "description": "Nexive (TNT Post Italy)." - }, - { - "value": "IT_POSTE_ITALIA", - "description": "Poste italiane (www.poste.it)." - }, - { - "value": "IT_TNT", - "description": "TNT Italy." - }, - { - "value": "IVOY_WEBHOOK", - "description": "Ivoy courier." - }, - { - "value": "I_DIKA", - "description": "i-dika." - }, - { - "value": "JANCO", - "description": "Janco Ecommerce." - }, - { - "value": "JANIO", - "description": "Janio Asia." - }, - { - "value": "JERSEY_POST", - "description": "Jersey Post." - }, - { - "value": "JET_SHIP", - "description": "Jet-Ship Worldwide." - }, - { - "value": "JINDOUYUN", - "description": "jindouyun courier." - }, - { - "value": "JINSUNG", - "description": "JINSUNG TRADING." - }, - { - "value": "JOCOM", - "description": "Jocom." - }, - { - "value": "JOOM_LOGIS", - "description": "Joom Logistics." - }, - { - "value": "JOYING_BOX", - "description": "Joying Box." - }, - { - "value": "JPN_JAPAN_POST", - "description": "Japan Post." - }, - { - "value": "JPN_SAGAWA", - "description": "Sagawa Express Japan." - }, - { - "value": "JP_KURO_NEKO_YAMATO_UNYUU", - "description": "Yamato transport (www.kuronekoyamato.co.jp)." - }, - { - "value": "JS_EXPRESS", - "description": "JS EXPRESS." - }, - { - "value": "JTEXPRESS", - "description": "J&T EXPRESS MALAYSIA." - }, - { - "value": "JTEXPRESS_VN", - "description": "J&T Express Vietnam." - }, - { - "value": "JX", - "description": "JX courier." - }, - { - "value": "J_NET", - "description": "J-Net." - }, - { - "value": "K1_EXPRESS", - "description": "K1 Express." - }, - { - "value": "KANGAROO_MY", - "description": "Kangaroo Worldwide Express." - }, - { - "value": "KEC", - "description": "KEC courier." - }, - { - "value": "KERRYTJ", - "description": "Kerry TJ Logistics." - }, - { - "value": "KERRYTTC_VN", - "description": "Kerry Express (Vietnam) Co Ltd." - }, - { - "value": "KERRY_ECOMMERCE", - "description": "Kerry eCommerce." - }, - { - "value": "KGMHUB", - "description": "KGM Hub." - }, - { - "value": "KHM_CAMBODIA_POST", - "description": "Cambodia Post." - }, - { - "value": "KOR_ECARGO", - "description": "Ecargo." - }, - { - "value": "KPOST", - "description": "Korea Post." - }, - { - "value": "KR_KOREA_POST", - "description": "Koreapost (www.koreapost.go.kr)." - }, - { - "value": "KUEHNE", - "description": "Kuehne + Nagel." - }, - { - "value": "KURASI", - "description": "KURASI." - }, - { - "value": "KWE_GLOBAL", - "description": "KWE Global." - }, - { - "value": "KWT", - "description": "Shenzhen Jinghuada Logistics Co.." - }, - { - "value": "KYUNGDONG_PARCEL", - "description": "Kyungdong Parcel." - }, - { - "value": "KY_EXPRESS", - "description": "Kua Yue Express." - }, - { - "value": "LALAMOVE", - "description": "Lalamove." - }, - { - "value": "LANDMARK_GLOBAL", - "description": "Landmark Global." - }, - { - "value": "LANDMARK_GLOBAL_REFERENCE", - "description": "Landmark Global Reference." - }, - { - "value": "LATVIJAS_PASTS", - "description": "Latvijas Pasts." - }, - { - "value": "LA_POSTE_SUIVI", - "description": "La Poste." - }, - { - "value": "LBCEXPRESS_FTP", - "description": "LBC EXPRESS INC.." - }, - { - "value": "LEADER", - "description": "leader." - }, - { - "value": "LEGION_EXPRESS", - "description": "Legion Express." - }, - { - "value": "LEXSHIP", - "description": "LexShip." - }, - { - "value": "LHT_EXPRESS", - "description": "LHT Express." - }, - { - "value": "LICCARDI_EXPRESS", - "description": "LICCARDI EXPRESS COURIER." - }, - { - "value": "LIEFERY", - "description": "liefery." - }, - { - "value": "LINE", - "description": "Line Clear Express & Logistics Sdn Bhd." - }, - { - "value": "LINKBRIDGE", - "description": "Link Bridge(BeiJing)international logistics co.." - }, - { - "value": "LOCUS_WEBHOOK", - "description": "Locus courier." - }, - { - "value": "LOGISTERS", - "description": "Logisters." - }, - { - "value": "LOGISTICSWORLDWIDE_HK", - "description": "Logistic Worldwide Express (LWE Honkong)." - }, - { - "value": "LOGISTIKA", - "description": "Logistika." - }, - { - "value": "LOGISTYX_TRANSGROUP", - "description": "Transgroup courier." - }, - { - "value": "LONESTAR", - "description": "Lone Star Overnight." - }, - { - "value": "LOOMIS_EXPRESS", - "description": "Loomis Express." - }, - { - "value": "LOTTE", - "description": "Lotte Global Logistics." - }, - { - "value": "LTIANEXP", - "description": "LTIAN EXP." - }, - { - "value": "LTL", - "description": "LTL COURIER." - }, - { - "value": "LTU_LIETUVOS", - "description": "Lietuvos pastas." - }, - { - "value": "MAGYAR_HU", - "description": "Magyar Post." - }, - { - "value": "MAILAMERICAS", - "description": "MailAmericas." - }, - { - "value": "MAILPLUS_JPN", - "description": "MailPlus (Japan)." - }, - { - "value": "MAIL_PLUS", - "description": "MailPlus." - }, - { - "value": "MAINFREIGHT", - "description": "Mainfreight." - }, - { - "value": "MAINWAY", - "description": "Mainway." - }, - { - "value": "MATDESPATCH", - "description": "Matdespatch." - }, - { - "value": "MATKAHUOLTO", - "description": "Matkahuolto." - }, - { - "value": "MBW", - "description": "MBW Courier Inc.." - }, - { - "value": "MEX_AEROFLASH", - "description": "Aeroflash Mexico." - }, - { - "value": "MEX_ESTAFETA", - "description": "Estafeta (www.estafeta.com)." - }, - { - "value": "MEX_REDPACK", - "description": "Redpack." - }, - { - "value": "MEX_SENDA", - "description": "mexico senda express." - }, - { - "value": "MGLOBAL", - "description": "PT MGLOBAL LOGISTICS INDONESIA." - }, - { - "value": "MIKROPAKKET", - "description": "Mikropakket." - }, - { - "value": "MIKROPAKKET_BE", - "description": "Mikropakket Belgium." - }, - { - "value": "MILKMAN", - "description": "Milkman courier." - }, - { - "value": "MORE_LINK", - "description": "Morelink." - }, - { - "value": "MORNING_EXPRESS", - "description": "Morning Express." - }, - { - "value": "MRW_FTP", - "description": "MRW courier." - }, - { - "value": "MXE", - "description": "MXE Express." - }, - { - "value": "MX_CARGO", - "description": "M&X cargo." - }, - { - "value": "MYHERMES", - "description": "MyHermes UK." - }, - { - "value": "MYS_AIRPAK", - "description": "Airpak Express." - }, - { - "value": "MYS_EMS", - "description": "Malaysia Post EMS / Pos Laju." - }, - { - "value": "MYS_GDEX", - "description": "GDEX courier." - }, - { - "value": "MYS_MYPOST_ONLINE", - "description": "Mypostonline." - }, - { - "value": "MYS_MYS_POST", - "description": "Malaysia Post." - }, - { - "value": "MYS_SKYNET", - "description": "Skynet Malaysia." - }, - { - "value": "M_XPRESS", - "description": "M Xpress Sdn Bhd." - }, - { - "value": "NACEX", - "description": "NACEX." - }, - { - "value": "NACEX_ES", - "description": "NACEX Spain." - }, - { - "value": "NANJINGWOYUAN", - "description": "Nanjing Woyuan." - }, - { - "value": "NATIONAL_SAMEDAY", - "description": "National Sameday." - }, - { - "value": "NATIONEX", - "description": "Nationex courier." - }, - { - "value": "NATIONWIDE_MY", - "description": "Nationwide Express Courier Services Bhd (www.nationwide.com.my)." - }, - { - "value": "NEWAY", - "description": "Neway Transport." - }, - { - "value": "NEWEGGEXPRESS", - "description": "Newegg Express." - }, - { - "value": "NEWGISTICS", - "description": "Newgistics." - }, - { - "value": "NEWZEALAND_COURIERS", - "description": "NEW ZEALAND COURIERS." - }, - { - "value": "NG_COURIERPLUS", - "description": "Courier Plus." - }, - { - "value": "NHANS_SOLUTIONS", - "description": "Nhans Solutions." - }, - { - "value": "NIM_EXPRESS", - "description": "Nim Express." - }, - { - "value": "NINJAVAN_MY", - "description": "ninja van (www.ninjavan.co)." - }, - { - "value": "NINJAVAN_SG", - "description": "Ninja van Singapore." - }, - { - "value": "NINJAVAN_THAI", - "description": "Ninja van Thai." - }, - { - "value": "NINJAVAN_WB", - "description": "Ninjavan Webhook." - }, - { - "value": "NIPOST_NG", - "description": "NIpost (www.nipost.gov.ng)." - }, - { - "value": "NLD_DHL", - "description": "DHL Netherland." - }, - { - "value": "NLD_GLS", - "description": "GLS Netherland." - }, - { - "value": "NLD_POSTNL", - "description": "PostNL International." - }, - { - "value": "NLD_TRANSMISSION", - "description": "TransMission." - }, - { - "value": "NOVA_POSHTA", - "description": "Nova Poshta (novaposhta.ua)." - }, - { - "value": "NOVA_POSHTA_INT", - "description": "Nova Poshta (International)." - }, - { - "value": "NOX_NACHTEXPRESS", - "description": "Innight Express Germany GmbH (nox NachtExpress)." - }, - { - "value": "NOX_NIGHT_TIME_EXPRESS", - "description": "NOX NightTimeExpress." - }, - { - "value": "NTLOGISTICS_VN", - "description": "Nhat Tin Logistics." - }, - { - "value": "NZ_COURIER_POST", - "description": "CourierPost Newsland." - }, - { - "value": "NZ_NZ_POST", - "description": "New Zealand Post." - }, - { - "value": "OCS", - "description": "OCS ANA Group." - }, - { - "value": "OCS_WORLDWIDE", - "description": "OCS WORLDWIDE." - }, - { - "value": "OKAYPARCEL", - "description": "OkayParcel." - }, - { - "value": "OMNIPARCEL", - "description": "Omni Parcel." - }, - { - "value": "OMNIVA", - "description": "Omniva." - }, - { - "value": "ONECLICK", - "description": "One click delivery services." - }, - { - "value": "ONEWORLDEXPRESS", - "description": "One World Express." - }, - { - "value": "ORANGE_DS", - "description": "OrangeDS (Orange Distribution Solutions Inc)." - }, - { - "value": "OSM_WORLDWIDE", - "description": "OSM Worldwide." - }, - { - "value": "OVERSE_EXP", - "description": "Overseas Express." - }, - { - "value": "P2P_TRC", - "description": "P2P TrakPak." - }, - { - "value": "PAACK_WEBHOOK", - "description": "Paack courier." - }, - { - "value": "PADTF", - "description": "padtf.com." - }, - { - "value": "PAGO", - "description": "Pago Logistics." - }, - { - "value": "PALEXPRESS", - "description": "PAL Express Limited." - }, - { - "value": "PALLETWAYS", - "description": "Palletways." - }, - { - "value": "PALLET_NETWORK", - "description": "The Pallet Network." - }, - { - "value": "PANTHER_REFERENCE", - "description": "Panther Reference." - }, - { - "value": "PAN_ASIA", - "description": "Pan-Asia International." - }, - { - "value": "PAPERFLY", - "description": "Paperfly Private Limited." - }, - { - "value": "PAPER_EXPRESS", - "description": "Paper Express." - }, - { - "value": "PAQUETEXPRESS", - "description": "Paquetexpress." - }, - { - "value": "PARCEL2GO", - "description": "Parcel2Go." - }, - { - "value": "PARCELINKLOGISTICS", - "description": "Parcelink Logistics." - }, - { - "value": "PARCELLED_IN", - "description": "Parcelled.in." - }, - { - "value": "PARCELONE", - "description": "PARCEL ONE." - }, - { - "value": "PARCELPAL_WEBHOOK", - "description": "ParcelPal." - }, - { - "value": "PARCELPOINT", - "description": "Parcelpoint." - }, - { - "value": "PARCELPOST_SG", - "description": "Parcel Post Singapore." - }, - { - "value": "PARCEL_2_POST", - "description": "Parcel To Post." - }, - { - "value": "PARKNPARCEL", - "description": "Park N Parcel." - }, - { - "value": "PCFCORP", - "description": "PCF Final Mile." - }, - { - "value": "PFCEXPRESS", - "description": "PFC Express." - }, - { - "value": "PFLOGISTICS", - "description": "PFL." - }, - { - "value": "PHL_AIR21", - "description": "AIR21 courier." - }, - { - "value": "PHL_AIRSPEED", - "description": "Airspeed International." - }, - { - "value": "PHL_JAMEXPRESS", - "description": "Jam Express Philippines." - }, - { - "value": "PICKRR", - "description": "Pickrr." - }, - { - "value": "PICKUP", - "description": "Pickupp." - }, - { - "value": "PICKUPP_MYS", - "description": "PICK UPP." - }, - { - "value": "PICKUPP_SGP", - "description": "PICK UPP (Singapore)." - }, - { - "value": "PILOT_FREIGHT", - "description": "Pilot Freight Services." - }, - { - "value": "PIL_LOGISTICS", - "description": "PIL Logistics (China) Co.." - }, - { - "value": "PITNEY_BOWES", - "description": "Pitney Bowes." - }, - { - "value": "PITTOHIO", - "description": "PITT OHIO." - }, - { - "value": "PIXSELL", - "description": "PIXSELL LOGISTICS." - }, - { - "value": "PLANZER", - "description": "Planzer Group." - }, - { - "value": "PLUS_LOG_UK", - "description": "Plus UK Logistics." - }, - { - "value": "PL_POCZTA_POLSKA", - "description": "Poczta Polska (www.poczta-polska.pl)." - }, - { - "value": "POL_SIODEMKA", - "description": "Siodemka." - }, - { - "value": "PONY_EXPRESS", - "description": "Pony express." - }, - { - "value": "POSTA_PLUS", - "description": "Posta Plus." - }, - { - "value": "POSTA_RO", - "description": "Post Roman (www.posta-romana.ro)." - }, - { - "value": "POSTA_UKR", - "description": "UkrPoshta." - }, - { - "value": "POSTEN_NORGE", - "description": "Posten Norge (www.posten.no)." - }, - { - "value": "POSTI", - "description": "Posti courier." - }, - { - "value": "POSTNL_INTL_3S", - "description": "PostNL International 3S." - }, - { - "value": "POSTNL_INT_3_S", - "description": "PostNL International." - }, - { - "value": "POSTNORD_LOGISTICS", - "description": "PostNord Logistics." - }, - { - "value": "POSTNORD_LOGISTICS_DK", - "description": "ostnord denmark." - }, - { - "value": "POSTUR_IS", - "description": "Iceland Post." - }, - { - "value": "POST_SERBIA", - "description": "Posta Serbia." - }, - { - "value": "POST_SLOVENIA", - "description": "Post of Slovenia." - }, - { - "value": "PRESIDENT_TRANS", - "description": "PRESIDENT TRANSNET CORP." - }, - { - "value": "PRESSIODE", - "description": "Pressio." - }, - { - "value": "PRIMAMULTICIPTA", - "description": "PT Prima Multi Cipta." - }, - { - "value": "PROMEDDELIVERY", - "description": "ProMed Delivery." - }, - { - "value": "PRT_CHRONOPOST", - "description": "Chronopost Portugal." - }, - { - "value": "PRT_CTT", - "description": "CTT Portugal." - }, - { - "value": "PRT_INT_SEUR", - "description": "SEUR International." - }, - { - "value": "PRT_SEUR", - "description": "SEUR portugal." - }, - { - "value": "PTS", - "description": "PTS courier." - }, - { - "value": "PTT_POST", - "description": "PTT Post." - }, - { - "value": "QUANTIUM", - "description": "Quantium." - }, - { - "value": "QWINTRY", - "description": "Qwintry Logistics." - }, - { - "value": "RABEN_GROUP", - "description": "Raben Group." - }, - { - "value": "RAF_PH", - "description": "RAF Philippines." - }, - { - "value": "RAIDEREX", - "description": "RaidereX." - }, - { - "value": "RAM", - "description": "RAM courier." - }, - { - "value": "RCL", - "description": "Red Carpet Logistics." - }, - { - "value": "RINCOS", - "description": "Rincos." - }, - { - "value": "RL_US", - "description": "RL Carriers." - }, - { - "value": "ROADBULL", - "description": "Red Carpet Logistics." - }, - { - "value": "ROADRUNNER_FREIGHT", - "description": "Roadbull Logistics." - }, - { - "value": "ROCKET_PARCEL", - "description": "Rocket Parcel International." - }, - { - "value": "ROUTIFIC_WEBHOOK", - "description": "Routific." - }, - { - "value": "ROYAL_MAIL", - "description": "RoyalShipments." - }, - { - "value": "RPD2MAN", - "description": "RPD2man Deliveries." - }, - { - "value": "RPX", - "description": "RPX Online." - }, - { - "value": "RPXLOGISTICS", - "description": "RPX Logistics." - }, - { - "value": "RPX_ID", - "description": "RPX Indonesia." - }, - { - "value": "RUSSIAN_POST", - "description": "Russian post." - }, - { - "value": "RUSTON", - "description": "Ruston." - }, - { - "value": "RZYEXPRESS", - "description": "RZY Express." - }, - { - "value": "SAIA_FREIGHT", - "description": "Saia LTL Freight." - }, - { - "value": "SAILPOST", - "description": "SAILPOST." - }, - { - "value": "SAP_EXPRESS", - "description": "SAP EXPRESS." - }, - { - "value": "SAU_SAUDI_POST", - "description": "Saudi Post." - }, - { - "value": "SCUDEX_EXPRESS", - "description": "Scudex Express." - }, - { - "value": "SDA_IT", - "description": "SDA Italy." - }, - { - "value": "SDH_SCM", - "description": "lightning monkey" - }, - { - "value": "SEFL", - "description": "Southeastern Freight Lines." - }, - { - "value": "SEINO", - "description": "Seino." - }, - { - "value": "SEKOLOGISTICS", - "description": "SEKO Logistics." - }, - { - "value": "SEKO_SFTP", - "description": "SEKO Worldwide." - }, - { - "value": "SENDING", - "description": "Sending Transporte Urgente y Comunicacion." - }, - { - "value": "SENDIT", - "description": "Sendit." - }, - { - "value": "SENDLE", - "description": "Sendle." - }, - { - "value": "SEUR_ES", - "description": "Seur Spain." - }, - { - "value": "SEUR_SP_API", - "description": "Spanish Seur API." - }, - { - "value": "SFB2C", - "description": "SF International." - }, - { - "value": "SFCSERVICE", - "description": "SFC Service." - }, - { - "value": "SFC_LOGISTICS", - "description": "SFC." - }, - { - "value": "SFPLUS_WEBHOOK", - "description": "Zeek courier." - }, - { - "value": "SF_EX", - "description": "SF Express." - }, - { - "value": "SG_DETRACK", - "description": "Detrack." - }, - { - "value": "SG_QXPRESS", - "description": "Qxpress." - }, - { - "value": "SG_SG_POST", - "description": "Singapore Post." - }, - { - "value": "SG_SPEEDPOST", - "description": "Singapore Speedpost." - }, - { - "value": "SG_TAQBIN", - "description": "Taqbin Singapore." - }, - { - "value": "SHENZHEN", - "description": "shenzhen 1st International Logistics(Group)Co." - }, - { - "value": "SHIPENTEGRA", - "description": "ShipEntegra." - }, - { - "value": "SHIPPIT", - "description": "Shippit." - }, - { - "value": "SHIPTER", - "description": "SHIPTER." - }, - { - "value": "SHIPTOR", - "description": "Shiptor." - }, - { - "value": "SHIP_GATE", - "description": "ShipGate." - }, - { - "value": "SHIP_IT_ASIA", - "description": "Ship It Asia." - }, - { - "value": "SHOPFANS", - "description": "ShopfansRU LLC." - }, - { - "value": "SHREENANDANCOURIER", - "description": "SHREE NANDAN COURIER." - }, - { - "value": "SHREETIRUPATI", - "description": "SHREE TIRUPATI COURIER SERVICES PVT. LTD.." - }, - { - "value": "SHREE_ANJANI_COURIER", - "description": "Shree Anjani Courier." - }, - { - "value": "SHREE_MARUTI", - "description": "Shree Maruti Courier Services Pvt Ltd." - }, - { - "value": "SIMPLYPOST", - "description": "J&T Express Singapore." - }, - { - "value": "SINOTRANS", - "description": "Sinotrans." - }, - { - "value": "SIN_GLBL", - "description": "Sin Global Express." - }, - { - "value": "SKYBOX", - "description": "SKYBOX." - }, - { - "value": "SKYNET_UAE", - "description": "SKYNET UAE." - }, - { - "value": "SKYNET_UK", - "description": "Skynet UK." - }, - { - "value": "SKYNET_WORLDWIDE", - "description": "SkyNet Worldwide Express." - }, - { - "value": "SKYNET_ZA", - "description": "Skynet World Wide Express South Africa." - }, - { - "value": "SKY_POSTAL", - "description": "SkyPostal." - }, - { - "value": "SK_POSTA", - "description": "Slovenska pošta." - }, - { - "value": "SMG_EXPRESS", - "description": "SMG Direct." - }, - { - "value": "SMOOTH", - "description": "Smooth Couriers." - }, - { - "value": "SMSA_EXPRESS", - "description": "SMSA Express." - }, - { - "value": "SONICTL", - "description": "Sonic Transportation & Logistics." - }, - { - "value": "SOUTH_AFRICAN_POST_OFFICE", - "description": "South African Post Office." - }, - { - "value": "SPEEDCOURIERS_GR", - "description": "Speed Couriers." - }, - { - "value": "SPEEDEE", - "description": "Spee-Dee Delivery." - }, - { - "value": "SPEEDEXCOURIER", - "description": "SPEEDEX couriers." - }, - { - "value": "SPOTON", - "description": "SPOTON Logistics Pvt Ltd." - }, - { - "value": "SPRING_GDS", - "description": "Spring GDS." - }, - { - "value": "SRE_KOREA", - "description": "SRE Korea (www.srekorea.co.kr)." - }, - { - "value": "STALLIONEXPRESS", - "description": "Stallion Express." - }, - { - "value": "STARKEN", - "description": "STARKEN couriers." - }, - { - "value": "STAR_TRACK_EXPRESS", - "description": "Star Track Express." - }, - { - "value": "STAR_TRACK_NEXT_FLIGHT", - "description": "Star Track Next Flight." - }, - { - "value": "STEPFORWARDFS", - "description": "STEP FORWARD FREIGHT SERVICE CO LTD." - }, - { - "value": "STONE3PL", - "description": "STONE3PL." - }, - { - "value": "STRECK_TRANSPORT", - "description": "Streck Transport." - }, - { - "value": "SUTTON", - "description": "Sutton Transport." - }, - { - "value": "SWE_POSTNORD", - "description": "Postnord sweden." - }, - { - "value": "SWISHIP_DE", - "description": "Swiship DE." - }, - { - "value": "SWISS_POST_FTP", - "description": "Swiss Post FTP." - }, - { - "value": "SYPOST", - "description": "Sunyou Post." - }, - { - "value": "SZENDEX", - "description": "SZENDEX." - }, - { - "value": "TAQBIN_HK", - "description": "TAQBIN Hong Kong." - }, - { - "value": "TAQBIN_MY", - "description": "TAQBIN Malaysia." - }, - { - "value": "TARRIVE", - "description": "TONDA GLOBAL." - }, - { - "value": "TAZMANIAN_FREIGHT", - "description": "Tazmanian Freight Systems." - }, - { - "value": "TCK_EXPRESS", - "description": "TCK Express." - }, - { - "value": "TCS", - "description": "TCS courier." - }, - { - "value": "TFM", - "description": "TFM Xpress." - }, - { - "value": "TFORCE_FINALMILE", - "description": "TForce Final Mile." - }, - { - "value": "THABIT_LOGISTICS", - "description": "Thabit Logistics." - }, - { - "value": "THA_DYNAMIC_LOGISTICS", - "description": "Dynamic Logistics." - }, - { - "value": "THA_KERRY", - "description": "Kerry Express Thailand." - }, - { - "value": "THA_THAILAND_POST", - "description": "Thailand Post (www.thailandpost.co.th)." - }, - { - "value": "THECOURIERGUY", - "description": "The Courier Guy." - }, - { - "value": "THEDELIVERYGROUP", - "description": "TDG – The Delivery Group." - }, - { - "value": "THENILE_WEBHOOK", - "description": "SortHub courier." - }, - { - "value": "TIGFREIGHT", - "description": "TIG Freight." - }, - { - "value": "TIKI_ID", - "description": "Tiki shipment." - }, - { - "value": "TIPSA", - "description": "TIPSA courier." - }, - { - "value": "TNT", - "description": "TNT Express." - }, - { - "value": "TNT_CLICK_IT", - "description": "TNT-Click Italy." - }, - { - "value": "TNT_FR", - "description": "TNT France." - }, - { - "value": "TNT_NL", - "description": "THT Netherland." - }, - { - "value": "TNT_REFR", - "description": "TNT Reference." - }, - { - "value": "TNT_UK", - "description": "TNT UK Limited (www.tnt.com)." - }, - { - "value": "TNT_UK_REFR", - "description": "TNT UK Reference." - }, - { - "value": "TOLL", - "description": "Toll IPEC." - }, - { - "value": "TOLL_NZ", - "description": "Toll New Zealand." - }, - { - "value": "TOLOS", - "description": "Tolos courier." - }, - { - "value": "TOPHATTEREXPRESS", - "description": "Tophatter Express." - }, - { - "value": "TOPYOU", - "description": "TopYou." - }, - { - "value": "TOTAL_EXPRESS", - "description": "Total Express." - }, - { - "value": "TOURLINE", - "description": "tourline." - }, - { - "value": "TRACKON", - "description": "Trackon Couriers Pvt. Ltd." - }, - { - "value": "TRANS_KARGO", - "description": "Trans Kargo Internasional." - }, - { - "value": "TRUMPCARD", - "description": "TRUMPCARD LLC." - }, - { - "value": "TRUNKRS_WEBHOOK", - "description": "Trunkrs courier." - }, - { - "value": "TUFFNELLS_REFERENCE", - "description": "Tuffnells Parcels Express- Reference." - }, - { - "value": "TWO_GO", - "description": "2GO Courier." - }, - { - "value": "TW_TAIWAN_POST", - "description": "Taiwan Post." - }, - { - "value": "UBI_LOGISTICS", - "description": "UBI Smart Parcel." - }, - { - "value": "UC_EXPRE", - "description": "ucexpress." - }, - { - "value": "UDS", - "description": "United Delivery Service." - }, - { - "value": "UK_COLLECTPLUS", - "description": "Collect plus." - }, - { - "value": "UK_DPD", - "description": "DPD UK." - }, - { - "value": "UK_NIGHTLINE", - "description": "Nightline(www.nightline.ie)." - }, - { - "value": "UK_PARCELFORCE", - "description": "Parcel Force." - }, - { - "value": "UK_UK_MAIL", - "description": "UK mail (ukmail.com)." - }, - { - "value": "UK_XDP", - "description": "XDP Express." - }, - { - "value": "UK_YODEL", - "description": "Yodel (www.yodel.co.uk)." - }, - { - "value": "UPS", - "description": "United Parcel Service." - }, - { - "value": "UPS_FREIGHT", - "description": "UPS Freight." - }, - { - "value": "UPS_MAIL_INNOVATIONS", - "description": "UPS Mail Innovations." - }, - { - "value": "UPS_REFERENCE", - "description": "UPS Reference." - }, - { - "value": "USF_REDDAWAY", - "description": "USF Reddaway." - }, - { - "value": "USHIP", - "description": "uShip courier." - }, - { - "value": "USPS", - "description": "United States Postal Service." - }, - { - "value": "US_GLOBEGISTICS", - "description": "Globegistics US." - }, - { - "value": "US_LASERSHIP", - "description": "LaserShip." - }, - { - "value": "US_OLD_DOMINION", - "description": "Old Dominion Freight Line." - }, - { - "value": "US_ONTRAC", - "description": "OnTrac Logistics." - }, - { - "value": "US_YRC", - "description": "YRC courier." - }, - { - "value": "VAMOX", - "description": "VAMOX." - }, - { - "value": "VENIPAK", - "description": "Venipak." - }, - { - "value": "VIAEUROPE", - "description": "ViaEurope." - }, - { - "value": "VIA_EXPRESS", - "description": "Viaxpress." - }, - { - "value": "VIRTRANSPORT", - "description": "VIR Transport." - }, - { - "value": "VIWO", - "description": "VIWO IoT." - }, - { - "value": "VNM_VIETNAM_POST", - "description": "Vietnam Post." - }, - { - "value": "VNM_VIETTELPOST", - "description": "ViettelPost." - }, - { - "value": "WAHANA_ID", - "description": "Wahana express (www.wahana.com)." - }, - { - "value": "WANBEXPRESS", - "description": "WanbExpress." - }, - { - "value": "WEASHIP", - "description": "Weaship." - }, - { - "value": "WEPOST", - "description": "WePost Sdn Bhd." - }, - { - "value": "WESTBANK_COURIER", - "description": "West Bank Courier." - }, - { - "value": "WESTGATE_GL", - "description": "Westgate Global." - }, - { - "value": "WHISTL", - "description": "Whistl." - }, - { - "value": "WINIT", - "description": "WinIt." - }, - { - "value": "WISELOADS", - "description": "Wiseloads." - }, - { - "value": "WISE_EXPRESS", - "description": "Wise Express." - }, - { - "value": "WIZMO", - "description": "Wizmo." - }, - { - "value": "WMG", - "description": "WMG Delivery." - }, - { - "value": "WNDIRECT", - "description": "wnDirect." - }, - { - "value": "WYNGS", - "description": "Wyngs." - }, - { - "value": "XDE_WEBHOOK", - "description": "Ximex Delivery Express." - }, - { - "value": "XDP_UK_REFERENCE", - "description": "XDP Express Reference." - }, - { - "value": "XL_EXPRESS", - "description": "XL Express." - }, - { - "value": "XPERT_DELIVERY", - "description": "Xpert Delivery." - }, - { - "value": "XPOST", - "description": "Xpost.ph." - }, - { - "value": "XPO_LOGISTICS", - "description": "XPO logistics." - }, - { - "value": "XPRESSEN_DK", - "description": "Xpressen courier." - }, - { - "value": "XQ_EXPRESS", - "description": "XQ Express." - }, - { - "value": "YAKIT", - "description": "Yakit courier." - }, - { - "value": "YANWEN", - "description": "Yanwen Logistics." - }, - { - "value": "YDH_EXPRESS", - "description": "YDH express." - }, - { - "value": "YINGNUO_LOGISTICS", - "description": "yingnuo logistics." - }, - { - "value": "YODEL_DIR", - "description": "Yodel Direct." - }, - { - "value": "YODEL_INTNL", - "description": "Yodel International." - }, - { - "value": "YTO", - "description": "YTO Express." - }, - { - "value": "YUNEXPRESS", - "description": "YunExpress." - }, - { - "value": "YURTICI_KARGO", - "description": "Yurtici Kargo." - }, - { - "value": "YUSEN", - "description": "Yusen Logistics." - }, - { - "value": "ZAJIL_EXPRESS", - "description": "Zajil Express Company." - }, - { - "value": "ZA_COURIERIT", - "description": "Courier IT." - }, - { - "value": "ZA_FASTWAY", - "description": "fastway New Zealand." + "400": { + "description": "The request is not well-formed, syntactically incorrect, or violates schema.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + } }, - { - "value": "ZA_SPECIALISED_FREIGHT", - "description": "Specialised Freight." + "403": { + "description": "Permission denied to access the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + } }, - { - "value": "ZEEK_2_DOOR", - "description": "Zeek2Door." + "422": { + "description": "The request cannot be fulfilled as it violates the business definition.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + } }, - { - "value": "ZELERIS", - "description": "Zeleris." + "500": { + "description": "Internal server error.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + } }, + "default": { + "description": "The error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + } + } + }, + "parameters": [ { - "value": "ZEPTO_EXPRESS", - "description": "ZeptoExpress." - }, + "$ref": "#/components/parameters/id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tracker" + } + } + } + }, + "security": [ { - "value": "ZES_EXPRESS", - "description": "Eshun international Logistic." + "Oauth2": [ + "https://uri.paypal.com/services/shipping/trackers/readwrite" + ] + } + ], + "tags": ["trackers"] + }, + "get": { + "summary": "Show tracking information", + "description": "Shows tracking information, by tracker ID, for a PayPal transaction.", + "operationId": "trackers.get", + "responses": { + "200": { + "description": "A successful request returns the HTTP `200 OK` status code and a JSON response body that shows tracking information.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tracker" + } + } + } }, + "default": { + "description": "The error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + } + } + }, + "parameters": [ { - "value": "ZIINGFINALMILE", - "description": "Ziing Final Mile Inc." + "$ref": "#/components/parameters/id" }, { - "value": "ZINC", - "description": "Zinc courier." - }, + "$ref": "#/components/parameters/account_id" + } + ], + "security": [ { - "value": "ZJS_EXPRESS", - "description": "ZJS International." + "Oauth2": [ + "https://uri.paypal.com/services/shipping/trackers/read", + "https://uri.paypal.com/services/shipping/trackers/readwrite" + ] + } + ], + "tags": ["trackers"] + } + } + }, + "components": { + "requestBodies": { + "tracker_collection": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tracker_collection" + } + } + } + } + }, + "securitySchemes": { + "Oauth2": { + "type": "oauth2", + "description": "Oauth 2.0 authentication", + "flows": { + "clientCredentials": { + "tokenUrl": "/v1/oauth2/token", + "scopes": { + "https://uri.paypal.com/services/shipping/trackers/readwrite": "Create or update tracking information", + "https://uri.paypal.com/services/shipping/trackers/read": "Retrieve tracking information" + } + } + } + } + }, + "schemas": { + "batch_tracker_collection": { + "type": "object", + "title": "Batch Tracker Collection", + "description": "The add tracking information for multiple PayPal transactions response details.", + "properties": { + "tracker_identifiers": { + "$ref": "#/components/schemas/tracker_identifier_list" }, - { - "value": "ZTO_EXPRESS", - "description": "ZTO Express." + "errors": { + "$ref": "#/components/schemas/error_list" }, - { - "value": "ZYLLEM", - "description": "Zyllem." + "links": { + "$ref": "#/components/schemas/batch_tracker_collection_definitions-link_description_list" } - ], - "enum": [ - "2EBOX", - "360LION", - "3JMSLOGISTICS", - "4_72", - "6LS", - "A1POST", - "AAA_COOPER", - "ABCUSTOM", - "ABXEXPRESS_MY", - "ACOMMMERCE", - "ACSWORLDWIDE", - "ACS_GR", - "ADERONLINE", - "ADICIONAL", - "ADSONE", - "ADUIEPYLE", - "AERONET", - "AEX", - "AFLLOG_FTP", - "AGILITY", - "AIRMEE_WEBHOOK", - "AIR_CANADA_GLOBAL", - "ALFATREX", - "ALLIEDEXPRESS", - "ALLJOY", - "ALPHAFAST", - "ALWAYS_EXPRESS", - "AMAZON", - "AMAZON_FBA_SWISHIP", - "AMAZON_SHIP_MCF", - "AMSTAN", - "AMS_GRP", - "ANDREANI", - "ANICAM_BOX", - "ANJUN", - "ANSERX", - "AN_POST", - "AO_COURIER", - "AO_DEUTSCHLAND", - "APC_OVERNIGHT", - "APC_OVERNIGHT_CONNUM", - "APG", - "APRISAEXPRESS", - "AQUILINE", - "ARAMEX", - "ARAMEX_AU", - "ARCO_SPEDIZIONI", - "ARE_EMIRATES_POST", - "ARG_OCA", - "ARK_LOGISTICS", - "ASE", - "ASENDIA_HK", - "ASENDIA_UK", - "ASENDIA_USA", - "ASIGNA", - "AUPOST_CN", - "AUSTRIAN_POST_EXPRESS", - "AUS_STARTRACK", - "AUS_TOLL", - "AU_AUSTRIAN_POST", - "AU_AU_POST", - "AU_TNT", - "AVERITT", - "BEL_DHL", - "BEL_RS", - "BESTWAYPARCEL", - "BE_BPOST", - "BE_KIALA", - "BG_BULGARIAN_POST", - "BH_POSTA", - "BH_WORLDWIDE", - "BIRDSYSTEM", - "BJSHOMEDELIVERY", - "BLINKLASTMILE", - "BLR_BELPOST", - "BLUECARE", - "BLUESTAR", - "BLUEX", - "BNEED", - "BOMBINOEXP", - "BOND", - "BONDSCOURIERS", - "BORDEREXPRESS", - "BOX_BERRY", - "BPOST_INT", - "BRA_CORREIOS", - "BRING", - "BROUWER_TRANSPORT", - "BRT_IT", - "BRT_IT_PARCELID", - "BRT_IT_SENDER_REF", - "BUDBEE_WEBHOOK", - "BUYLOGIC", - "B_TWO_C_EUROPE", - "CAE_DELIVERS", - "CAINIAO", - "CARIBOU", - "CARRIERS", - "CARRY_FLAP", - "CA_CANADA_POST", - "CA_CANPAR", - "CA_GREYHOUND", - "CA_PUROLATOR", - "CBL_LOGISTICA", - "CDEK", - "CDEK_TR", - "CELERITAS", - "CELLO_SQUARE", - "CESKA_CZ", - "CEVA", - "CFL_LOGISTICS", - "CGS_EXPRESS", - "CHAMPION_LOGISTICS", - "CHITCHATS", - "CHOIR_EXP", - "CHROBINSON", - "CHRONOPOST_FR", - "CHUKOU1", - "CH_SWISS_POST_PRIORITY", - "CITYLINK_MY", - "CJPACKET", - "CJ_CENTURY", - "CJ_GLS", - "CJ_HK_INTERNATIONAL", - "CJ_INT_MY", - "CJ_KR", - "CJ_LOGISTICS", - "CJ_TH", - "CLEVY_LINKS", - "CLE_LOGISTICS", - "CLOUDWISH_ASIA", - "CNDEXPRESS", - "CNEXPS", - "CNWANGTONG", - "CN_17POST", - "CN_BESTEXPRESS", - "CN_BOXC", - "CN_CHINA_POST_EMS", - "CN_DPEX", - "CN_EMS", - "CN_EQUICK", - "CN_JCEX", - "CN_PAYPAL_PACKAGE", - "CN_POST56", - "CN_SF_EXPRESS", - "CN_STO", - "CN_WEDO", - "CN_WISHPOST", - "CN_YUNDA", - "COLIS_PRIVE", - "COLLECTCO", - "COLLIVERY", - "COMET_TECH", - "CONTINENTAL", - "CON_WAY", - "COORDINADORA", - "COPA_COURIER", - "COPE", - "CORPORATECOURIERS_WEBHOOK", - "CORREOS_DE_MEXICO", - "CORREOS_ES", - "CORREOS_EXPRESS", - "CORREO_UY", - "COSTMETICSNOW", - "COURANT_PLUS", - "COUREX", - "COURIERS_PLEASE", - "CPACKET", - "CPEX", - "CROSHOT", - "CSE", - "CTC_EXPRESS", - "CUBYN", - "CUCKOOEXPRESS", - "CYPRUS_POST_CYP", - "DAIGLOBALTRACK", - "DAJIN", - "DANSKE_FRAGT", - "DAWN_WING", - "DAYTON_FREIGHT", - "DBSCHENKER_B2B", - "DBSCHENKER_SE", - "DBSCHENKER_SV", - "DDEXPRESS", - "DEALERSEND", - "DELIVERYONTIME", - "DELNEXT", - "DELTEC_UK", - "DEMANDSHIP", - "DESCARTES", - "DESIGNERTRANSPORT_WEBHOOK", - "DESTINY", - "DEX_I", - "DE_ASENDIA", - "DE_DEUTSCHE", - "DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET", - "DE_DHL_EXPRESS", - "DE_DPD_DELISTRACK", - "DE_GLS", - "DHL", - "DHL_ACTIVE_TRACING", - "DHL_AU", - "DHL_BENELUX", - "DHL_ECOMERCE_ASA", - "DHL_ES", - "DHL_FR", - "DHL_FREIGHT", - "DHL_GLOBAL_MAIL_ASIA", - "DHL_HK", - "DHL_JP", - "DHL_PARCEL_ES", - "DHL_PARCEL_NL", - "DHL_PARCEL_RU", - "DHL_PL", - "DHL_REFR", - "DHL_SG", - "DHL_SUPPLY_CHAIN", - "DHL_UK", - "DIAMOND_EUROGISTICS", - "DICOM", - "DIDADI", - "DIMERCO", - "DIRECTCOURIERS", - "DIRECTLOG", - "DIRECTPARCELS", - "DMM_NETWORK", - "DMS_MATRIX", - "DOBROPOST", - "DOORA", - "DOORDASH_WEBHOOK", - "DPD", - "DPD_DELISTRACK", - "DPD_FR", - "DPD_HGRY", - "DPD_HK", - "DPD_IR", - "DPD_LOCAL", - "DPD_LOCAL_REF", - "DPD_POLAND", - "DPD_RO", - "DPD_RU", - "DPEX", - "DPE_EXPRESS", - "DPE_SOUTH_AFRC", - "DSV", - "DTDC_AU", - "DTDC_EXPRESS", - "DTDC_IN", - "DTD_EXPR", - "DX_SFTP", - "DYLT", - "DYNALOGIC", - "EASY_MAIL", - "ECEXPRESS", - "ECHO", - "ECMS", - "ECOSCOOTING", - "EFEX", - "EFS", - "EKART", - "ELIAN_POST", - "EMPS_CN", - "ENDEAVOUR_DELIVERY", - "ENVIALIA_REFERENCE", - "EPARCEL_KR", - "EPST_GLBL", - "EP_BOX", - "ESHIPPING", - "ESP_ASM", - "ESP_ENVIALIA", - "ESP_MRW", - "ESP_NACEX", - "ESP_PACKLINK", - "ESP_REDUR", - "ETOMARS", - "ETOTAL", - "ETS_EXPRESS", - "EU_FLEET_SOLUTIONS", - "EU_IMX", - "EXPRESSSALE", - "FARGOOD", - "FAR_INTERNATIONAL", - "FASTRACK", - "FASTRK_SERV", - "FASTWAY_IR", - "FASTWAY_NZ", - "FDSEXPRESS", - "FEDEX", - "FEDEX_CROSSBORDER", - "FEDEX_FR", - "FEDEX_INTL_MLSERV", - "FEDEX_POLAND", - "FEDEX_UK", - "FETCHR_WEBHOOK", - "FIEGE", - "FIEGE_NL", - "FIRSTMILE", - "FLASHEXPRESS", - "FMX", - "FONSEN", - "FORRUN", - "FREIGHTQUOTE", - "FRETERAPIDO", - "FR_BERT", - "FR_COLIS", - "FR_EXAPAQ", - "FR_GEODIS", - "FR_GLS", - "FULFILLA", - "FULFILLME", - "FURDECO", - "GAC", - "GANGBAO", - "GBA", - "GBS_BROKER", - "GB_APC", - "GB_ARROW", - "GB_NORSK", - "GB_PANTHER", - "GB_TUFFNELLS", - "GEIS", - "GEL_EXPRESS", - "GEMWORLDWIDE", - "GENERAL_OVERNIGHT", - "GENIKI_GR", - "GEODIS_ESPACE", - "GESWL", - "GIAO_HANG", - "GIO_EXPRESS", - "GLOBALTRANZ", - "GLOBAL_ABF", - "GLOBAL_ESTES", - "GLOBAL_EXPRESS", - "GLOBAL_IPARCEL", - "GLOBAL_TNT", - "GLOBAVEND", - "GLS_CROTIA", - "GLS_CZ", - "GLS_IT", - "GLS_ITALY", - "GLS_SLOV", - "GLS_SLOVEN", - "GOGLOBALPOST", - "GOJEK", - "GRAB_WEBHOOK", - "GRUPO", - "GR_ELTA", - "GSI_EXPRESS", - "GSO", - "HAPPY2POINT", - "HCT_LOGISTICS", - "HDB", - "HDB_BOX", - "HELLMANN", - "HELTHJEM", - "HEPPNER", - "HEPPNER_FR", - "HERMES", - "HERMES_2MANN_HANDLING", - "HERMES_DE", - "HH_EXP", - "HIPSHIPPER", - "HKD", - "HK_FLYT_EXPRESS", - "HK_FOUR_PX_EXPRESS", - "HK_POST", - "HK_TGX", - "HOLISOL", - "HOME_DELIVERY_SOLUTIONS", - "HOUNDEXPRESS", - "HRPARCEL", - "HRV_HRVATSKA", - "HUAHAN_EXPRESS", - "HUNTER_EXPRESS", - "HUODULL", - "HX_EXPRESS", - "IBEONE", - "ICUMULUS", - "IDEXPRESS", - "IDN_JNE", - "IDN_LION_PARCEL", - "IDN_PANDU", - "IML", - "INDOPAKET", - "IND_BLUEDART", - "IND_DELHIVERY", - "IND_DELIVREE", - "IND_DOTZOT", - "IND_ECOM", - "IND_FIRSTFLIGHT", - "IND_GATI", - "IND_GOJAVAS", - "IND_PROFESSIONAL_COURIERS", - "IND_SAFEEXPRESS", - "IND_XPRESSBEES", - "INPOST_PACZKOMATY", - "INTEGRA2_FTP", - "INTELIPOST", - "INTEL_VALLEY", - "INTERPARCEL_AU", - "INTERPARCEL_NZ", - "INTERPARCEL_UK", - "INTEXPRESS", - "ISRAEL_POST", - "ISR_POST_DOMESTIC", - "IT_DHL_ECOMMERCE", - "IT_FERCAM", - "IT_NEXIVE", - "IT_POSTE_ITALIA", - "IT_TNT", - "IVOY_WEBHOOK", - "I_DIKA", - "JANCO", - "JANIO", - "JERSEY_POST", - "JET_SHIP", - "JINDOUYUN", - "JINSUNG", - "JOCOM", - "JOOM_LOGIS", - "JOYING_BOX", - "JPN_JAPAN_POST", - "JPN_SAGAWA", - "JP_KURO_NEKO_YAMATO_UNYUU", - "JS_EXPRESS", - "JTEXPRESS", - "JTEXPRESS_VN", - "JX", - "J_NET", - "K1_EXPRESS", - "KANGAROO_MY", - "KEC", - "KERRYTJ", - "KERRYTTC_VN", - "KERRY_ECOMMERCE", - "KGMHUB", - "KHM_CAMBODIA_POST", - "KOR_ECARGO", - "KPOST", - "KR_KOREA_POST", - "KUEHNE", - "KURASI", - "KWE_GLOBAL", - "KWT", - "KYUNGDONG_PARCEL", - "KY_EXPRESS", - "LALAMOVE", - "LANDMARK_GLOBAL", - "LANDMARK_GLOBAL_REFERENCE", - "LATVIJAS_PASTS", - "LA_POSTE_SUIVI", - "LBCEXPRESS_FTP", - "LEADER", - "LEGION_EXPRESS", - "LEXSHIP", - "LHT_EXPRESS", - "LICCARDI_EXPRESS", - "LIEFERY", - "LINE", - "LINKBRIDGE", - "LOCUS_WEBHOOK", - "LOGISTERS", - "LOGISTICSWORLDWIDE_HK", - "LOGISTIKA", - "LOGISTYX_TRANSGROUP", - "LONESTAR", - "LOOMIS_EXPRESS", - "LOTTE", - "LTIANEXP", - "LTL", - "LTU_LIETUVOS", - "MAGYAR_HU", - "MAILAMERICAS", - "MAILPLUS_JPN", - "MAIL_PLUS", - "MAINFREIGHT", - "MAINWAY", - "MATDESPATCH", - "MATKAHUOLTO", - "MBW", - "MEX_AEROFLASH", - "MEX_ESTAFETA", - "MEX_REDPACK", - "MEX_SENDA", - "MGLOBAL", - "MIKROPAKKET", - "MIKROPAKKET_BE", - "MILKMAN", - "MORE_LINK", - "MORNING_EXPRESS", - "MRW_FTP", - "MXE", - "MX_CARGO", - "MYHERMES", - "MYS_AIRPAK", - "MYS_EMS", - "MYS_GDEX", - "MYS_MYPOST_ONLINE", - "MYS_MYS_POST", - "MYS_SKYNET", - "M_XPRESS", - "NACEX", - "NACEX_ES", - "NANJINGWOYUAN", - "NATIONAL_SAMEDAY", - "NATIONEX", - "NATIONWIDE_MY", - "NEWAY", - "NEWEGGEXPRESS", - "NEWGISTICS", - "NEWZEALAND_COURIERS", - "NG_COURIERPLUS", - "NHANS_SOLUTIONS", - "NIM_EXPRESS", - "NINJAVAN_MY", - "NINJAVAN_SG", - "NINJAVAN_THAI", - "NINJAVAN_WB", - "NIPOST_NG", - "NLD_DHL", - "NLD_GLS", - "NLD_POSTNL", - "NLD_TRANSMISSION", - "NOVA_POSHTA", - "NOVA_POSHTA_INT", - "NOX_NACHTEXPRESS", - "NOX_NIGHT_TIME_EXPRESS", - "NTLOGISTICS_VN", - "NZ_COURIER_POST", - "NZ_NZ_POST", - "OCS", - "OCS_WORLDWIDE", - "OKAYPARCEL", - "OMNIPARCEL", - "OMNIVA", - "ONECLICK", - "ONEWORLDEXPRESS", - "ORANGE_DS", - "OSM_WORLDWIDE", - "OVERSE_EXP", - "P2P_TRC", - "PAACK_WEBHOOK", - "PADTF", - "PAGO", - "PALEXPRESS", - "PALLETWAYS", - "PALLET_NETWORK", - "PANTHER_REFERENCE", - "PAN_ASIA", - "PAPERFLY", - "PAPER_EXPRESS", - "PAQUETEXPRESS", - "PARCEL2GO", - "PARCELINKLOGISTICS", - "PARCELLED_IN", - "PARCELONE", - "PARCELPAL_WEBHOOK", - "PARCELPOINT", - "PARCELPOST_SG", - "PARCEL_2_POST", - "PARKNPARCEL", - "PCFCORP", - "PFCEXPRESS", - "PFLOGISTICS", - "PHL_AIR21", - "PHL_AIRSPEED", - "PHL_JAMEXPRESS", - "PICKRR", - "PICKUP", - "PICKUPP_MYS", - "PICKUPP_SGP", - "PILOT_FREIGHT", - "PIL_LOGISTICS", - "PITNEY_BOWES", - "PITTOHIO", - "PIXSELL", - "PLANZER", - "PLUS_LOG_UK", - "PL_POCZTA_POLSKA", - "POL_SIODEMKA", - "PONY_EXPRESS", - "POSTA_PLUS", - "POSTA_RO", - "POSTA_UKR", - "POSTEN_NORGE", - "POSTI", - "POSTNL_INTL_3S", - "POSTNL_INT_3_S", - "POSTNORD_LOGISTICS", - "POSTNORD_LOGISTICS_DK", - "POSTUR_IS", - "POST_SERBIA", - "POST_SLOVENIA", - "PRESIDENT_TRANS", - "PRESSIODE", - "PRIMAMULTICIPTA", - "PROMEDDELIVERY", - "PRT_CHRONOPOST", - "PRT_CTT", - "PRT_INT_SEUR", - "PRT_SEUR", - "PTS", - "PTT_POST", - "QUANTIUM", - "QWINTRY", - "RABEN_GROUP", - "RAF_PH", - "RAIDEREX", - "RAM", - "RCL", - "RINCOS", - "RL_US", - "ROADBULL", - "ROADRUNNER_FREIGHT", - "ROCKET_PARCEL", - "ROUTIFIC_WEBHOOK", - "ROYAL_MAIL", - "RPD2MAN", - "RPX", - "RPXLOGISTICS", - "RPX_ID", - "RUSSIAN_POST", - "RUSTON", - "RZYEXPRESS", - "SAIA_FREIGHT", - "SAILPOST", - "SAP_EXPRESS", - "SAU_SAUDI_POST", - "SCUDEX_EXPRESS", - "SDA_IT", - "SDH_SCM", - "SEFL", - "SEINO", - "SEKOLOGISTICS", - "SEKO_SFTP", - "SENDING", - "SENDIT", - "SENDLE", - "SEUR_ES", - "SEUR_SP_API", - "SFB2C", - "SFCSERVICE", - "SFC_LOGISTICS", - "SFPLUS_WEBHOOK", - "SF_EX", - "SG_DETRACK", - "SG_QXPRESS", - "SG_SG_POST", - "SG_SPEEDPOST", - "SG_TAQBIN", - "SHENZHEN", - "SHIPENTEGRA", - "SHIPPIT", - "SHIPTER", - "SHIPTOR", - "SHIP_GATE", - "SHIP_IT_ASIA", - "SHOPFANS", - "SHREENANDANCOURIER", - "SHREETIRUPATI", - "SHREE_ANJANI_COURIER", - "SHREE_MARUTI", - "SIMPLYPOST", - "SINOTRANS", - "SIN_GLBL", - "SKYBOX", - "SKYNET_UAE", - "SKYNET_UK", - "SKYNET_WORLDWIDE", - "SKYNET_ZA", - "SKY_POSTAL", - "SK_POSTA", - "SMG_EXPRESS", - "SMOOTH", - "SMSA_EXPRESS", - "SONICTL", - "SOUTH_AFRICAN_POST_OFFICE", - "SPEEDCOURIERS_GR", - "SPEEDEE", - "SPEEDEXCOURIER", - "SPOTON", - "SPRING_GDS", - "SRE_KOREA", - "STALLIONEXPRESS", - "STARKEN", - "STAR_TRACK_EXPRESS", - "STAR_TRACK_NEXT_FLIGHT", - "STEPFORWARDFS", - "STONE3PL", - "STRECK_TRANSPORT", - "SUTTON", - "SWE_POSTNORD", - "SWISHIP_DE", - "SWISS_POST_FTP", - "SYPOST", - "SZENDEX", - "TAQBIN_HK", - "TAQBIN_MY", - "TARRIVE", - "TAZMANIAN_FREIGHT", - "TCK_EXPRESS", - "TCS", - "TFM", - "TFORCE_FINALMILE", - "THABIT_LOGISTICS", - "THA_DYNAMIC_LOGISTICS", - "THA_KERRY", - "THA_THAILAND_POST", - "THECOURIERGUY", - "THEDELIVERYGROUP", - "THENILE_WEBHOOK", - "TIGFREIGHT", - "TIKI_ID", - "TIPSA", - "TNT", - "TNT_CLICK_IT", - "TNT_FR", - "TNT_NL", - "TNT_REFR", - "TNT_UK", - "TNT_UK_REFR", - "TOLL", - "TOLL_NZ", - "TOLOS", - "TOPHATTEREXPRESS", - "TOPYOU", - "TOTAL_EXPRESS", - "TOURLINE", - "TRACKON", - "TRANS_KARGO", - "TRUMPCARD", - "TRUNKRS_WEBHOOK", - "TUFFNELLS_REFERENCE", - "TWO_GO", - "TW_TAIWAN_POST", - "UBI_LOGISTICS", - "UC_EXPRE", - "UDS", - "UK_COLLECTPLUS", - "UK_DPD", - "UK_NIGHTLINE", - "UK_PARCELFORCE", - "UK_UK_MAIL", - "UK_XDP", - "UK_YODEL", - "UPS", - "UPS_FREIGHT", - "UPS_MAIL_INNOVATIONS", - "UPS_REFERENCE", - "USF_REDDAWAY", - "USHIP", - "USPS", - "US_GLOBEGISTICS", - "US_LASERSHIP", - "US_OLD_DOMINION", - "US_ONTRAC", - "US_YRC", - "VAMOX", - "VENIPAK", - "VIAEUROPE", - "VIA_EXPRESS", - "VIRTRANSPORT", - "VIWO", - "VNM_VIETNAM_POST", - "VNM_VIETTELPOST", - "WAHANA_ID", - "WANBEXPRESS", - "WEASHIP", - "WEPOST", - "WESTBANK_COURIER", - "WESTGATE_GL", - "WHISTL", - "WINIT", - "WISELOADS", - "WISE_EXPRESS", - "WIZMO", - "WMG", - "WNDIRECT", - "WYNGS", - "XDE_WEBHOOK", - "XDP_UK_REFERENCE", - "XL_EXPRESS", - "XPERT_DELIVERY", - "XPOST", - "XPO_LOGISTICS", - "XPRESSEN_DK", - "XQ_EXPRESS", - "YAKIT", - "YANWEN", - "YDH_EXPRESS", - "YINGNUO_LOGISTICS", - "YODEL_DIR", - "YODEL_INTNL", - "YTO", - "YUNEXPRESS", - "YURTICI_KARGO", - "YUSEN", - "ZAJIL_EXPRESS", - "ZA_COURIERIT", - "ZA_FASTWAY", - "ZA_SPECIALISED_FREIGHT", - "ZEEK_2_DOOR", - "ZELERIS", - "ZEPTO_EXPRESS", - "ZES_EXPRESS", - "ZIINGFINALMILE", - "ZINC", - "ZJS_EXPRESS", - "ZTO_EXPRESS", - "ZYLLEM" - ] + } + }, + "batch_tracker_collection_definitions-link_description_list": { + "type": "array", + "description": "An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/link_description" + }, + "minItems": 1, + "maxItems": 1 + }, + "carrier": { + "type": "string", + "title": "Carrier", + "description": "The carrier for the shipment. Carrier information is required when tracking_number is provided. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set `carrier` to `OTHER` and set carrier name in `carrier_name_other`. For allowed values, see Carriers.", + "minLength": 1, + "maxLength": 64, + "pattern": "^.*$" }, "date_no_time": { "type": "string", @@ -4789,6 +775,38 @@ "information_link": "https://developer.paypal.com/docs/api/orders/v2/#error-SERVICE_UNAVAILABLE" } }, + "error_default": { + "description": "The default error response.", + "oneOf": [ + { + "$ref": "#/components/schemas/error_400" + }, + { + "$ref": "#/components/schemas/error_401" + }, + { + "$ref": "#/components/schemas/error_403" + }, + { + "$ref": "#/components/schemas/error_404" + }, + { + "$ref": "#/components/schemas/error_409" + }, + { + "$ref": "#/components/schemas/error_415" + }, + { + "$ref": "#/components/schemas/error_422" + }, + { + "$ref": "#/components/schemas/error_500" + }, + { + "$ref": "#/components/schemas/error_503" + } + ] + }, "error_definitions-link_description_list": { "type": "array", "description": "An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links).", @@ -4992,7 +1010,7 @@ }, "tracking_number": { "type": "string", - "description": "The tracking number for the shipment. Carrier information, `carrier` is required if tracking_number is provided.", + "description": "The tracking number for the shipment. This property supports only ASCII characters and does not allow URL, phone number, or email formats. Carrier information (`carrier`) is required if a tracking number is provided.", "minLength": 1, "maxLength": 64, "pattern": "^.*$" @@ -5104,6 +1122,13 @@ "pattern": "^.*$", "description": "Tracking Link of the shipment." }, + "fulfillment_provider": { + "type": "string", + "description": "Indicates the fulfillment service used to deliver an order.", + "minLength": 1, + "maxLength": 64, + "pattern": "^.*$" + }, "links": { "$ref": "#/components/schemas/link_description_list" }