Note: For error handling and troubleshooting, see Orders v2 errors.", "operationId": "orders.create", "responses": { "200": { "description": "A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows order details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } } }, "201": { "description": "A successful request returns the HTTP `201 Created` status code and a JSON response body that includes by default a minimal response with the ID, status, and HATEOAS links. If you require the complete order resource representation, you must pass the
Prefer: return=representation request header. This header value is not the default.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
},
"examples": {
"orders_request_create": {
"value": {
"intent": "CAPTURE",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
}
}
}
}
},
"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/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"
}
]
}
}
}
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_422"
},
{
"$ref": "#/components/schemas/422"
}
]
}
}
}
},
"default": {
"$ref": "#/components/responses/default"
}
},
"parameters": [
{
"$ref": "#/components/parameters/paypal_request_id"
},
{
"$ref": "#/components/parameters/paypal_partner_attribution_id"
},
{
"$ref": "#/components/parameters/paypal_client_metadata_id"
},
{
"$ref": "#/components/parameters/prefer"
},
{
"$ref": "#/components/parameters/paypal_auth_assertion"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order_request"
},
"examples": {
"order_request": {
"value": {
"intent": "CAPTURE",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
],
"payment_source": {
"paypal": {
"experience_context": {
"payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED",
"payment_method_selected": "PAYPAL",
"brand_name": "EXAMPLE INC",
"locale": "en-US",
"landing_page": "LOGIN",
"user_action": "PAY_NOW",
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl"
}
}
}
}
}
}
}
},
"required": true
},
"security": [
{
"Oauth2": [
"https://uri.paypal.com/services/payments/payment",
"https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants"
]
}
],
"tags": ["orders"]
}
},
"/v2/checkout/orders/{id}": {
"get": {
"summary": "Show order details",
"description": "Shows details for an order, by ID.Note: For error handling and troubleshooting, see Orders v2 errors.", "operationId": "orders.get", "responses": { "200": { "description": "A successful request returns the HTTP `200 OK` status code and a JSON response body that shows order details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } } }, "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" } ] } } } }, "404": { "description": "The specified resource does not exist.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_404" }, { "$ref": "#/components/schemas/404" } ] } } } }, "default": { "$ref": "#/components/responses/default" } }, "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/paypal_auth_assertion" }, { "$ref": "#/components/parameters/fields" } ], "security": [ { "Oauth2": [ "https://uri.paypal.com/services/payments/payment", "https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants" ] } ], "tags": ["orders"] }, "patch": { "summary": "Update order", "description": "Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.
\\\"/purchase_units/@reference_id=='default'/{attribute-or-object}\\\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.Note: For error handling and troubleshooting, see Orders v2 errors.Patchable attributes or objects:
| Attribute | Op | Notes |
|---|---|---|
intent | replace | |
payer | replace, add | Using replace op for payer will replace the whole payer object with the value sent in request. |
purchase_units | replace, add | |
purchase_units[].custom_id | replace, add, remove | |
purchase_units[].description | replace, add, remove | |
purchase_units[].payee.email | replace | |
purchase_units[].shipping.name | replace, add | |
purchase_units[].shipping.email_address | replace, add | |
purchase_units[].shipping.phone_number | replace, add | |
purchase_units[].shipping.options | replace, add | |
purchase_units[].shipping.address | replace, add | |
purchase_units[].shipping.type | replace, add | |
purchase_units[].soft_descriptor | replace, remove | |
purchase_units[].amount | replace | |
purchase_units[].items | replace, add, remove | |
purchase_units[].invoice_id | replace, add, remove | |
purchase_units[].payment_instruction | replace | |
purchase_units[].payment_instruction.disbursement_mode | replace | By default, disbursement_mode is INSTANT. |
purchase_units[].payment_instruction.payee_receivable_fx_rate_id | replace, add, remove | |
purchase_units[].payment_instruction.platform_fees | replace, add, remove | |
purchase_units[].supplementary_data.airline | replace, add, remove | |
purchase_units[].supplementary_data.card | replace, add, remove | |
application_context.client_configuration | replace, add |
Note: For error handling and troubleshooting, see Orders v2 errors.", "operationId": "orders.authorize", "responses": { "200": { "description": "A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows authorized payment details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_authorize_response" } } } }, "201": { "description": "A successful response to a non-idempotent request returns the HTTP `201 Created` status code with a JSON response body that shows authorized payment details. If a duplicate response is retried, returns the HTTP `200 OK` status code. By default, the response is minimal. If you need the complete resource representation, you must pass the
Prefer: return=representation request header.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order_authorize_response"
}
}
}
},
"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/orders.authorize-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": "The authorized payment failed due to insufficient permissions.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_403"
},
{
"$ref": "#/components/schemas/orders.authorize-403"
}
]
}
}
}
},
"404": {
"description": "The specified resource does not exist.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_404"
},
{
"$ref": "#/components/schemas/404"
}
]
}
}
}
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_422"
},
{
"$ref": "#/components/schemas/orders.authorize-422"
}
]
}
}
}
},
"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/paypal_request_id"
},
{
"$ref": "#/components/parameters/prefer"
},
{
"$ref": "#/components/parameters/paypal_client_metadata_id"
},
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/paypal_auth_assertion"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order_authorize_request"
}
}
}
},
"security": [
{
"Oauth2": [
"https://uri.paypal.com/services/payments/payment",
"https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants"
]
}
],
"tags": ["orders"]
}
},
"/v2/checkout/orders/{id}/capture": {
"post": {
"summary": "Capture payment for order",
"description": "Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.Note: For error handling and troubleshooting, see Orders v2 errors.", "operationId": "orders.capture", "responses": { "200": { "description": "A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows captured payment details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } } }, "201": { "description": "A successful response to a non-idempotent request returns the HTTP `201 Created` status code with a JSON response body that shows captured payment details. If a duplicate response is retried, returns the HTTP `200 OK` status code. By default, the response is minimal. If you need the complete resource representation, pass the
Prefer: return=representation request header.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
}
}
}
},
"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/orders.capture-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": "The authorized payment failed due to insufficient permissions.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_403"
},
{
"$ref": "#/components/schemas/orders.capture-403"
}
]
}
}
}
},
"404": {
"description": "The specified resource does not exist.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_404"
},
{
"$ref": "#/components/schemas/404"
}
]
}
}
}
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_422"
},
{
"$ref": "#/components/schemas/orders.capture-422"
}
]
}
}
}
},
"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/paypal_request_id"
},
{
"$ref": "#/components/parameters/prefer"
},
{
"$ref": "#/components/parameters/paypal_client_metadata_id"
},
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/paypal_auth_assertion"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order_capture_request"
}
}
}
},
"security": [
{
"Oauth2": [
"https://uri.paypal.com/services/payments/payment",
"https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants"
]
}
],
"tags": ["orders"]
}
},
"/v2/checkout/orders/{id}/track": {
"post": {
"summary": "Add tracking information for an Order.",
"description": "Adds tracking information for an Order.",
"operationId": "orders.track.create",
"responses": {
"200": {
"description": "A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows tracker details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
}
}
}
},
"201": {
"description": "A successful response to a non-idempotent request returns the HTTP `201 Created` status code with a JSON response body that shows tracker details. If a duplicate response is retried, returns the HTTP `200 OK` status code.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
}
}
}
},
"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/orders.track.create-400"
}
]
}
}
}
},
"403": {
"description": "Authorization failed due to insufficient permissions.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_403"
},
{
"$ref": "#/components/schemas/orders.track.create-403"
}
]
}
}
}
},
"404": {
"description": "The specified resource does not exist.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_404"
},
{
"$ref": "#/components/schemas/404"
}
]
}
}
}
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_422"
},
{
"$ref": "#/components/schemas/orders.track.create-422"
}
]
}
}
}
},
"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/id"
},
{
"$ref": "#/components/parameters/paypal_auth_assertion"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order_tracker_request"
}
}
},
"required": true
},
"security": [
{
"Oauth2": ["https://uri.paypal.com/services/payments/payment"]
}
],
"tags": ["orders"]
}
},
"/v2/checkout/orders/{id}/trackers/{tracker_id}": {
"patch": {
"summary": "Update or cancel tracking information for an order",
"description": "Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:| Attribute | Op | Notes |
|---|---|---|
items | replace | Using replace op for items will replace the entire items object with the value sent in request. |
notify_payer | replace, add | |
status | replace | Only patching status to CANCELLED is currently supported. |
item_total.value can not be a negative number.",
"$ref": "#/components/schemas/money"
},
"shipping": {
"description": "The shipping fee for all items within a given `purchase_unit`. shipping.value can not be a negative number.",
"$ref": "#/components/schemas/money"
},
"handling": {
"description": "The handling fee for all items within a given `purchase_unit`. handling.value can not be a negative number.",
"$ref": "#/components/schemas/money"
},
"tax_total": {
"description": "The total tax for all items. Required if the request includes `purchase_units.items.tax`. Must equal the sum of `(items[].tax * items[].quantity)` for all items. tax_total.value can not be a negative number.",
"$ref": "#/components/schemas/money"
},
"insurance": {
"description": "The insurance fee for all items within a given `purchase_unit`. insurance.value can not be a negative number.",
"$ref": "#/components/schemas/money"
},
"shipping_discount": {
"description": "The shipping discount for all items within a given `purchase_unit`. shipping_discount.value can not be a negative number.",
"$ref": "#/components/schemas/money"
},
"discount": {
"description": "The discount for all items within a given `purchase_unit`. discount.value can not be a negative number.",
"$ref": "#/components/schemas/money"
}
}
},
"amount_with_breakdown": {
"type": "object",
"title": "Amount with Breakdown",
"description": "The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.status.details."
}
],
"enum": [
"CREATED",
"CAPTURED",
"DENIED",
"PARTIALLY_CAPTURED",
"VOIDED",
"PENDING"
]
},
"status_details": {
"description": "The details of the authorized order pending status.",
"readOnly": true,
"$ref": "#/components/schemas/authorization_status_details"
}
}
},
"authorization_status_details": {
"title": "Authorization Status Details",
"description": "The details of the authorized payment status.",
"type": "object",
"properties": {
"reason": {
"title": "Authorization Incomplete Reason",
"description": "The reason why the authorized status is `PENDING`.",
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Z_]+$",
"x-enumDescriptions": [
{
"value": "PENDING_REVIEW",
"description": "Authorization is pending manual review."
},
{
"value": "DECLINED_BY_RISK_FRAUD_FILTERS",
"description": "Risk Filter set by the payee failed for the transaction."
}
],
"enum": ["PENDING_REVIEW", "DECLINED_BY_RISK_FRAUD_FILTERS"]
}
}
},
"authorization_with_additional_data": {
"type": "object",
"title": "Authorization with Additional Data",
"description": "The authorization with additional payment details, such as risk assessment and processor response. These details are populated only for certain payment methods.",
"allOf": [
{
"$ref": "#/components/schemas/authorization"
},
{
"properties": {
"processor_response": {
"$ref": "#/components/schemas/processor_response",
"description": "The processor response for card transactions.",
"readOnly": true
}
}
}
]
},
"authorization_with_additional_data_list": {
"type": "array",
"description": "An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.",
"items": {
"$ref": "#/components/schemas/authorization_with_additional_data"
}
},
"bancontact": {
"type": "object",
"title": "Bancontact payment object",
"description": "Information used to pay Bancontact.",
"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"
},
"bic": {
"description": "The bank identification code (BIC).",
"$ref": "#/components/schemas/bic"
},
"iban_last_chars": {
"$ref": "#/components/schemas/iban_last_chars"
},
"card_last_digits": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "[0-9]{4}",
"description": "The last digits of the card used to fund the Bancontact payment."
}
}
},
"bancontact_request": {
"type": "object",
"title": "Bancontact payment request",
"description": "Information needed to pay using Bancontact.",
"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_base"
}
},
"required": ["name", "country_code"]
},
"bic": {
"type": "string",
"title": "BIC",
"description": "The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.",
"minLength": 8,
"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_agreement_id": {
"type": "string",
"description": "The PayPal billing agreement ID. References an approved recurring payment for goods or services.",
"minLength": 2,
"maxLength": 128,
"pattern": "^[a-zA-Z0-9-]+$"
},
"billing_cycle": {
"title": "Billing Cycle",
"description": "The billing cycle providing details of the billing frequency, amount, duration and if the billing cycle is a free, discounted or regular billing cycle. The sequence of the billing cycle will be in the following order - free trial billing cycle(s), discounted trial billing cycle(s), regular billing cycle(s).",
"type": "object",
"properties": {
"tenure_type": {
"type": "string",
"description": "The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.",
"minLength": 1,
"maxLength": 24,
"pattern": "^[A-Z_]+$",
"x-enumDescriptions": [
{
"value": "REGULAR",
"description": "A regular billing cycle to identify recurring charges for the billing agreement."
},
{
"value": "TRIAL",
"description": "A trial billing cycle to identify free or discounted charge for the billing agreement. Free trails will not have a price object in pricing scheme where as a discounted trial would have a discounted price compared to regular billing cycle."
}
],
"enum": ["REGULAR", "TRIAL"]
},
"pricing_scheme": {
"description": "The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.",
"$ref": "#/components/schemas/pricing_scheme"
},
"frequency": {
"description": "The frequency details for this billing cycle.",
"$ref": "#/components/schemas/frequency"
},
"total_cycles": {
"type": "integer",
"description": "The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).",
"minimum": 0,
"maximum": 999,
"default": 1,
"format": "int32"
},
"sequence": {
"type": "integer",
"description": "The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial cycle runs before the regular cycle.",
"minimum": 1,
"maximum": 3,
"default": 1,
"format": "int32"
},
"start_date": {
"description": "The start date for the billing cycle, in YYYY-MM-DD. This field should be not be provided if the billing cycle starts at the time of checkout. When this field is not provided, the billing cycle amount will be included in any data validations confirming that the total provided by the merchant match the sum of individual items due at the time of checkout. Only one billing cycle (with sequence equal to 1) can have a no start date.",
"$ref": "#/components/schemas/date_no_time"
}
},
"required": ["tenure_type"]
},
"billing_cycle_list": {
"type": "array",
"description": "An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.",
"minItems": 1,
"maxItems": 3,
"items": {
"$ref": "#/components/schemas/billing_cycle"
}
},
"bin_details": {
"type": "object",
"title": "Bin Details",
"description": "Bank Identification Number (BIN) details used to fund a payment.",
"properties": {
"bin": {
"type": "string",
"description": "The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card.",
"pattern": "^[0-9]+$",
"maxLength": 25,
"minLength": 1
},
"issuing_bank": {
"type": "string",
"description": "The issuer of the card instrument.",
"minLength": 1,
"maxLength": 64
},
"bin_country_code": {
"description": "The [two-character ISO-3166-1 country code](/docs/integration/direct/rest/country-codes/) of the bank.",
"$ref": "#/components/schemas/country_code-2"
},
"products": {
"$ref": "#/components/schemas/products_list"
}
}
},
"blik": {
"type": "object",
"title": "BLIK payment object",
"description": "Information used to pay using BLIK.",
"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"
},
"email": {
"description": "The email address of the account holder associated with this payment method.",
"$ref": "#/components/schemas/email_address"
},
"one_click": {
"description": "The one-click integration flow object.",
"$ref": "#/components/schemas/blik_one_click_response"
}
}
},
"blik_experience_context": {
"type": "object",
"title": "BLIK Experience Context",
"description": "Customizes the payer experience during the approval process for the BLIK payment.",
"allOf": [
{
"$ref": "#/components/schemas/experience_context_base"
},
{
"properties": {
"consumer_ip": {
"description": "The IP address of the consumer. It could be either IPv4 or IPv6.",
"$ref": "#/components/schemas/ip_address"
},
"consumer_user_agent": {
"type": "string",
"description": "The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0).",
"minLength": 1,
"maxLength": 256,
"pattern": "^.*$"
}
}
}
]
},
"blik_one_click": {
"type": "object",
"title": "BLIK one-click payment request",
"description": "Information used to pay using BLIK one-click flow.",
"properties": {
"auth_code": {
"type": "string",
"description": "The 6-digit code used to authenticate a consumer within BLIK.",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]{6}$"
},
"consumer_reference": {
"type": "string",
"description": "The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.",
"minLength": 3,
"maxLength": 64,
"pattern": "^[ -~]{3,64}$"
},
"alias_label": {
"type": "string",
"description": "A bank defined identifier used as a display name to allow the payer to differentiate between multiple registered bank accounts.",
"minLength": 8,
"maxLength": 35,
"pattern": "^[ -~]{8,35}$"
},
"alias_key": {
"type": "string",
"description": "A Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given merchant. Used only in conjunction with a Consumer Reference.",
"minLength": 1,
"maxLength": 19,
"pattern": "^[0-9]+$"
}
},
"required": ["consumer_reference"]
},
"blik_one_click_response": {
"type": "object",
"title": "BLIK one-click payment object",
"description": "Information used to pay using BLIK one-click flow.",
"properties": {
"consumer_reference": {
"type": "string",
"description": "The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.",
"minLength": 3,
"maxLength": 64,
"pattern": "^[ -~]{3,64}$"
}
}
},
"blik_request": {
"type": "object",
"title": "BLIK payment request",
"description": "Information needed to pay using BLIK.",
"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"
},
"email": {
"description": "The email address of the account holder associated with this payment method.",
"$ref": "#/components/schemas/email_address"
},
"experience_context": {
"description": "Customizes the payer experience during the approval process for the payment.",
"$ref": "#/components/schemas/blik_experience_context"
},
"level_0": {
"description": "The level_0 integration flow object.",
"$ref": "#/components/schemas/blik_seamless"
},
"one_click": {
"description": "The one-click integration flow object.",
"$ref": "#/components/schemas/blik_one_click"
}
},
"required": ["name", "country_code"]
},
"blik_seamless": {
"type": "object",
"title": "BLIK level_0 payment object",
"description": "Information used to pay using BLIK level_0 flow.",
"properties": {
"auth_code": {
"type": "string",
"description": "The 6-digit code used to authenticate a consumer within BLIK.",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]{6}$"
}
},
"required": ["auth_code"]
},
"callback_configuration": {
"type": "object",
"title": "CallBack Configuration that the merchant can provide to PayPal/Venmo.",
"description": "CallBack Configuration that the merchant can provide to PayPal/Venmo.",
"properties": {
"callback_events": {
"$ref": "#/components/schemas/callback_events_list"
},
"callback_url": {
"type": "string",
"description": "Merchant provided CallBack url.PayPal/Venmo will use this url to call the merchant back when the events occur .PayPal/Venmo expects a secured url usually in the https format.merchant can append the cart id or other params part of the url as query or path params.",
"minLength": 10,
"maxLength": 2040,
"pattern": "^.*$",
"format": "uri"
}
},
"required": ["callback_events", "callback_url"]
},
"callback_events": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[0-9A-Z_]+$",
"description": "CallBack event.",
"x-enumDescriptions": [
{
"value": "SHIPPING_ADDRESS",
"description": "When Buyer changes or selects the shipping address on the PayPal/Venmo buyer approval flow , PayPal/Venmo will call merchant with the callback URL to update order totals."
},
{
"value": "SHIPPING_OPTIONS",
"description": "When Buyer changes or selects the shipping options on the PayPal/Venmo buyer approval flow , PayPal/Venmo will call merchant with the callback URL to update order totals."
}
],
"enum": ["SHIPPING_ADDRESS", "SHIPPING_OPTIONS"]
},
"callback_events_list": {
"type": "array",
"description": "An array of callback events merchant can subscribe to for the corresponding callback url.",
"minItems": 1,
"maxItems": 5,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/callback_events"
}
},
"capture": {
"type": "object",
"title": "Capture",
"description": "A captured payment.",
"allOf": [
{
"$ref": "#/components/schemas/capture_status"
},
{
"properties": {
"id": {
"description": "The PayPal-generated ID for the captured payment.",
"type": "string",
"readOnly": true
},
"amount": {
"description": "The amount for this captured payment.",
"$ref": "#/components/schemas/money",
"readOnly": true
},
"invoice_id": {
"description": "The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.",
"type": "string",
"readOnly": true
},
"custom_id": {
"type": "string",
"description": "The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.",
"maxLength": 255
},
"network_transaction_reference": {
"$ref": "#/components/schemas/network_transaction"
},
"seller_protection": {
"$ref": "#/components/schemas/seller_protection",
"readOnly": true
},
"final_capture": {
"description": "Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.",
"type": "boolean",
"default": false,
"readOnly": true
},
"seller_receivable_breakdown": {
"$ref": "#/components/schemas/seller_receivable_breakdown",
"readOnly": true
},
"disbursement_mode": {
"$ref": "#/components/schemas/disbursement_mode"
},
"links": {
"$ref": "#/components/schemas/capture_definitions-link_description_list"
},
"processor_response": {
"description": "An object that provides additional processor information for a direct credit card transaction.",
"$ref": "#/components/schemas/processor_response"
}
}
},
{
"$ref": "#/components/schemas/activity_timestamps"
}
]
},
"capture_definitions-link_description_list": {
"description": "An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/link_description"
}
},
"capture_list": {
"type": "array",
"description": "An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.",
"items": {
"$ref": "#/components/schemas/capture"
}
},
"capture_status": {
"type": "object",
"title": "Capture Status With Details",
"description": "The status and status details of a captured payment.",
"properties": {
"status": {
"title": "Capture Status",
"description": "The status of the captured payment.",
"type": "string",
"x-enumDescriptions": [
{
"value": "COMPLETED",
"description": "The funds for this captured payment were credited to the payee's PayPal account."
},
{
"value": "DECLINED",
"description": "The funds could not be captured."
},
{
"value": "PARTIALLY_REFUNDED",
"description": "An amount less than this captured payment's amount was partially refunded to the payer."
},
{
"value": "PENDING",
"description": "The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details."
},
{
"value": "REFUNDED",
"description": "An amount greater than or equal to this captured payment's amount was refunded to the payer."
},
{
"value": "FAILED",
"description": "There was an error while capturing payment."
}
],
"readOnly": true,
"enum": [
"COMPLETED",
"DECLINED",
"PARTIALLY_REFUNDED",
"PENDING",
"REFUNDED",
"FAILED"
]
},
"status_details": {
"description": "The details of the captured payment status.",
"readOnly": true,
"$ref": "#/components/schemas/capture_status_details"
}
}
},
"capture_status_details": {
"title": "Capture Status Details",
"description": "The details of the captured payment status.",
"type": "object",
"properties": {
"reason": {
"title": "Capture Incomplete Reason",
"description": "The reason why the captured payment status is `PENDING` or `DENIED`.",
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Z_]+$",
"x-enumDescriptions": [
{
"value": "BUYER_COMPLAINT",
"description": "The payer initiated a dispute for this captured payment with PayPal."
},
{
"value": "CHARGEBACK",
"description": "The captured funds were reversed in response to the payer disputing this captured payment with the issuer of the financial instrument used to pay for this captured payment."
},
{
"value": "ECHECK",
"description": "The payer paid by an eCheck that has not yet cleared."
},
{
"value": "INTERNATIONAL_WITHDRAWAL",
"description": "Visit your online account. In your **Account Overview**, accept and deny this payment."
},
{
"value": "OTHER",
"description": "No additional specific reason can be provided. For more information about this captured payment, visit your account online or contact PayPal."
},
{
"value": "PENDING_REVIEW",
"description": "The captured payment is pending manual review."
},
{
"value": "RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION",
"description": "The payee has not yet set up appropriate receiving preferences for their account. For more information about how to accept or deny this payment, visit your account online. This reason is typically offered in scenarios such as when the currency of the captured payment is different from the primary holding currency of the payee."
},
{
"value": "REFUNDED",
"description": "The captured funds were refunded."
},
{
"value": "TRANSACTION_APPROVED_AWAITING_FUNDING",
"description": "The payer must send the funds for this captured payment. This code generally appears for manual EFTs."
},
{
"value": "UNILATERAL",
"description": "The payee does not have a PayPal account."
},
{
"value": "VERIFICATION_REQUIRED",
"description": "The payee's PayPal account is not verified."
},
{
"value": "DECLINED_BY_RISK_FRAUD_FILTERS",
"description": "Risk Filter set by the payee failed for the transaction."
}
],
"enum": [
"BUYER_COMPLAINT",
"CHARGEBACK",
"ECHECK",
"INTERNATIONAL_WITHDRAWAL",
"OTHER",
"PENDING_REVIEW",
"RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION",
"REFUNDED",
"TRANSACTION_APPROVED_AWAITING_FUNDING",
"UNILATERAL",
"VERIFICATION_REQUIRED",
"DECLINED_BY_RISK_FRAUD_FILTERS"
]
}
}
},
"card_attributes": {
"type": "object",
"title": "Card Attributes",
"description": "Additional attributes associated with the use of this card.",
"properties": {
"customer": {
"$ref": "#/components/schemas/card_customer"
},
"vault": {
"description": "Instruction to vault the card based on the specified strategy.",
"$ref": "#/components/schemas/vault_instruction_base"
},
"verification": {
"description": "Instruction to optionally verify the card based on the specified strategy.",
"$ref": "#/components/schemas/card_verification"
}
}
},
"card_attributes_response": {
"type": "object",
"title": "Card Attributes Response",
"description": "Additional attributes associated with the use of this card.",
"properties": {
"vault": {
"$ref": "#/components/schemas/card_vault_response"
}
}
},
"card_brand": {
"type": "string",
"title": "Card Brand",
"description": "The card network or brand. Applies to credit, debit, gift, and payment cards.",
"minLength": 1,
"maxLength": 255,
"pattern": "^[A-Z_]+$",
"x-enumDescriptions": [
{
"value": "VISA",
"description": "Visa card."
},
{
"value": "MASTERCARD",
"description": "Mastercard card."
},
{
"value": "DISCOVER",
"description": "Discover card."
},
{
"value": "AMEX",
"description": "American Express card."
},
{
"value": "SOLO",
"description": "Solo debit card."
},
{
"value": "JCB",
"description": "Japan Credit Bureau card."
},
{
"value": "STAR",
"description": "Military Star card."
},
{
"value": "DELTA",
"description": "Delta Airlines card."
},
{
"value": "SWITCH",
"description": "Switch credit card."
},
{
"value": "MAESTRO",
"description": "Maestro credit card."
},
{
"value": "CB_NATIONALE",
"description": "Carte Bancaire (CB) credit card."
},
{
"value": "CONFIGOGA",
"description": "Configoga credit card."
},
{
"value": "CONFIDIS",
"description": "Confidis credit card."
},
{
"value": "ELECTRON",
"description": "Visa Electron credit card."
},
{
"value": "CETELEM",
"description": "Cetelem credit card."
},
{
"value": "CHINA_UNION_PAY",
"description": "China union pay credit card."
},
{
"value": "DINERS",
"description": "The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services."
},
{
"value": "ELO",
"description": "The Brazilian Elo card payment network."
},
{
"value": "HIPER",
"description": "The Hiper - Ingenico ePayment network."
},
{
"value": "HIPERCARD",
"description": "The Brazilian Hipercard payment network that's widely accepted in the retail market."
},
{
"value": "RUPAY",
"description": "The RuPay payment network."
},
{
"value": "GE",
"description": "The GE Credit Union 3Point card payment network."
},
{
"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": "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."
}
],
"enum": [
"VISA",
"MASTERCARD",
"DISCOVER",
"AMEX",
"SOLO",
"JCB",
"STAR",
"DELTA",
"SWITCH",
"MAESTRO",
"CB_NATIONALE",
"CONFIGOGA",
"CONFIDIS",
"ELECTRON",
"CETELEM",
"CHINA_UNION_PAY",
"DINERS",
"ELO",
"HIPER",
"HIPERCARD",
"RUPAY",
"GE",
"SYNCHRONY",
"EFTPOS",
"CARTE_BANCAIRE",
"STAR_ACCESS",
"PULSE",
"NYCE",
"ACCEL",
"UNKNOWN"
]
},
"card_brand_list": {
"type": "array",
"description": "Array of brands or networks associated with the card.",
"readOnly": true,
"minItems": 1,
"maxItems": 256,
"items": {
"$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_experience_context": {
"type": "object",
"title": "Card Experience Context",
"description": "Customizes the payer experience during the 3DS Approval for payment.",
"properties": {
"return_url": {
"description": "The URL where the customer will be redirected upon successfully completing the 3DS challenge.",
"type": "string",
"minLength": 10,
"maxLength": 4000,
"format": "uri",
"$ref": "#/components/schemas/url"
},
"cancel_url": {
"description": "The URL where the customer will be redirected upon cancelling the 3DS challenge.",
"type": "string",
"minLength": 10,
"maxLength": 4000,
"format": "uri",
"$ref": "#/components/schemas/url"
}
}
},
"card_from_request": {
"type": "object",
"title": "Card from Request",
"description": "Representation of card details as received in the request.",
"properties": {
"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,}",
"minLength": 2,
"maxLength": 4,
"readOnly": true
}
}
},
"card_request": {
"type": "object",
"title": "Card Request",
"description": "The payment card to use to fund a payment. Can be a credit or debit card.Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.", "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 }, "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:
*PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide*.
Note: The country code for Great Britain is", "format": "ppaas_common_country_code_v2", "maxLength": 2, "minLength": 2, "pattern": "^([A-Z]{2}|C2)$" }, "country_code-2": { "type": "string", "description": "The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.GBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The country code for Great Britain is", "format": "ppaas_common_country_code_v2", "maxLength": 2, "minLength": 2, "pattern": "^([A-Z]{2}|C2)$" }, "crypto": {}, "crypto_request": {}, "currency_code": { "description": "The [three-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" } }, "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", "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" }, "email_address": { "description": "Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.", "$ref": "#/components/schemas/email" }, "phone": { "description": "The phone number of the customer as provided to the merchant or on file with the merchant. The `phone.phone_number` supports only `national_number`.", "$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 } } } } }, "date_no_time": { "type": "string", "description": "The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.", "format": "ppaas_date_notime_v2", "minLength": 10, "maxLength": 10, "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$" }, "date_time": { "type": "string", "description": "The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.GBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: The regular expression provides guidance but does not reject all invalid dates.", "format": "ppaas_date_time_v3", "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})$" }, "date_year_month": { "type": "string", "description": "The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).", "minLength": 7, "maxLength": 7, "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$" }, "definitions-link_description_list": { "type": "array", "description": "An array of request-related HATEOAS links.", "readOnly": true, "items": { "$ref": "#/components/schemas/link_description" } }, "definitions-platform_fee_list": { "type": "array", "description": "An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.", "minItems": 0, "maxItems": 1, "items": { "$ref": "#/components/schemas/platform_fee" } }, "definitions-purchase_unit_request_list": { "type": "array", "description": "An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.", "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/purchase_unit_request" } }, "definitions-shipping_option_list": { "type": "array", "minItems": 1, "maxItems": 10, "description": "An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.", "items": { "$ref": "#/components/schemas/shipping_option" } }, "disbursement_mode": { "type": "string", "title": "Disbursement Mode", "description": "The funds that are held on behalf of the merchant.", "default": "INSTANT", "minLength": 1, "maxLength": 16, "pattern": "^[A-Z_]+$", "x-enumDescriptions": [ { "value": "INSTANT", "description": "The funds are released to the merchant immediately.", "default": "INSTANT" }, { "value": "DELAYED", "description": "The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration." } ], "enum": ["INSTANT", "DELAYED"] }, "dispute_categories": { "type": "string", "description": "The condition that is covered for the transaction.", "x-enumDescriptions": [ { "value": "ITEM_NOT_RECEIVED", "description": "The payer paid for an item that they did not receive." }, { "value": "UNAUTHORIZED_TRANSACTION", "description": "The payer did not authorize the payment." } ], "enum": ["ITEM_NOT_RECEIVED", "UNAUTHORIZED_TRANSACTION"] }, "dispute_categories_list": { "type": "array", "description": "An array of conditions that are covered for the transaction.", "items": { "$ref": "#/components/schemas/dispute_categories" }, "readOnly": true }, "eci_flag": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[0-9A-Z_]+$", "description": "Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.", "x-enumDescriptions": [ { "value": "MASTERCARD_NON_3D_SECURE_TRANSACTION", "description": "Mastercard non-3-D Secure transaction." }, { "value": "MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION", "description": "Mastercard attempted authentication transaction." }, { "value": "MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION", "description": "Mastercard fully authenticated transaction." }, { "value": "FULLY_AUTHENTICATED_TRANSACTION", "description": "VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction." }, { "value": "ATTEMPTED_AUTHENTICATION_TRANSACTION", "description": "VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction." }, { "value": "NON_3D_SECURE_TRANSACTION", "description": "VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction." } ], "enum": [ "MASTERCARD_NON_3D_SECURE_TRANSACTION", "MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION", "MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION", "FULLY_AUTHENTICATED_TRANSACTION", "ATTEMPTED_AUTHENTICATION_TRANSACTION", "NON_3D_SECURE_TRANSACTION" ] }, "email": { "type": "string", "description": "The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the", "format": "merchant_common_email_address_v2", "maxLength": 254, "minLength": 3, "pattern": "(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])" }, "email_address": { "type": "string", "description": "The internationalized email address.@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the", "format": "ppaas_common_email_address_v2", "minLength": 3, "maxLength": 254, "pattern": "^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])$" }, "enrolled": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[0-9A-Z_]+$", "description": "Status of Authentication eligibility.", "x-enumDescriptions": [ { "value": "Y", "description": "Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl." }, { "value": "N", "description": "No. The bank is not participating in 3-D Secure protocol." }, { "value": "U", "description": "Unavailable. The DS or ACS is not available for authentication at the time of the request." }, { "value": "B", "description": "Bypass. The merchant authentication rule is triggered to bypass authentication." } ], "enum": ["Y", "N", "U", "B"] }, "eps": { "type": "object", "title": "EPS payment object", "description": "Information used to pay using eps.", "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" }, "bic": { "description": "The bank identification code (BIC).", "$ref": "#/components/schemas/bic" } } }, "eps_request": { "type": "object", "title": "EPS payment request", "description": "Information needed to pay using eps.", "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_base" } }, "required": ["name", "country_code"] }, "error_400": { "type": "object", "title": "Bad Request Error", "description": "Request is not well-formed, syntactically incorrect, or violates schema.", "properties": { "name": { "type": "string", "enum": ["INVALID_REQUEST"] }, "message": { "type": "string", "enum": [ "Request is not well-formed, syntactically incorrect, or violates schema." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_401": { "type": "object", "title": "Unauthorized Error", "description": "Authentication failed due to missing Authorization header, or invalid authentication credentials.", "properties": { "name": { "type": "string", "enum": ["AUTHENTICATION_FAILURE"] }, "message": { "type": "string", "enum": [ "Authentication failed due to missing authorization header, or invalid authentication credentials." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_403": { "type": "object", "title": "Not Authorized Error", "description": "The client is not authorized to access this resource, although it may have valid credentials. ", "properties": { "name": { "type": "string", "enum": ["NOT_AUTHORIZED"] }, "message": { "type": "string", "enum": ["Authorization failed due to insufficient permissions."] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_404": { "type": "object", "title": "Not found Error", "description": "The server has not found anything matching the request URI. This either means that the URI is incorrect or the resource is not available.", "properties": { "name": { "type": "string", "enum": ["RESOURCE_NOT_FOUND"] }, "message": { "type": "string", "enum": ["The specified resource does not exist."] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_409": { "type": "object", "title": "Resource Conflict Error", "description": "The server has detected a conflict while processing this request.", "properties": { "name": { "type": "string", "enum": ["RESOURCE_CONFLICT"] }, "message": { "type": "string", "enum": [ "The server has detected a conflict while processing this request." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_415": { "type": "object", "title": "Unsupported Media Type Error", "description": "The server does not support the request payload's media type.", "properties": { "name": { "type": "string", "enum": ["UNSUPPORTED_MEDIA_TYPE"] }, "message": { "type": "string", "enum": [ "The server does not support the request payload's media type." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_422": { "type": "object", "title": "Unprocessable Entity Error", "description": "The requested action cannot be performed and may require interaction with APIs or processes outside of the current request. This is distinct from a 500 response in that there are no systemic problems limiting the API from performing the request.", "properties": { "name": { "type": "string", "enum": ["UNPROCESSABLE_ENTITY"] }, "message": { "type": "string", "enum": [ "The requested action could not be performed, semantically incorrect, or failed business validation." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_500": { "type": "object", "title": "Internal Server Error", "description": "This is either a system or application error, and generally indicates that although the client appeared to provide a correct request, something unexpected has gone wrong on the server.", "properties": { "name": { "type": "string", "enum": ["INTERNAL_SERVER_ERROR"] }, "message": { "type": "string", "enum": ["An internal server error occurred."] }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } }, "example": { "name": "INTERNAL_SERVER_ERROR", "message": "An internal server error occurred.", "debug_id": "90957fca61718", "links": [ { "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR", "rel": "information_link" } ] } }, "error_503": { "type": "object", "title": "Service Unavailable Error", "description": "The server is temporarily unable to handle the request, for example, because of planned maintenance or downtime.", "properties": { "name": { "type": "string", "enum": ["SERVICE_UNAVAILABLE"] }, "message": { "type": "string", "enum": ["Service Unavailable."] }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } }, "example": { "name": "SERVICE_UNAVAILABLE", "message": "Service Unavailable.", "debug_id": "90957fca61718", "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", "description": "The error details. Required for client-side `4XX` errors.", "properties": { "field": { "type": "string", "description": "The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors." }, "value": { "type": "string", "description": "The value of the field that caused the error." }, "location": { "$ref": "#/components/schemas/error_location" }, "issue": { "type": "string", "description": "The unique, fine-grained application-level error code." }, "description": { "type": "string", "description": "The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value." } }, "required": ["issue"] }, "error_link_description": { "title": "Link Description", "description": "The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information.", "type": "object", "required": ["href", "rel"], "properties": { "href": { "description": "The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.", "type": "string", "minLength": 0, "maxLength": 20000, "pattern": "^.*$" }, "rel": { "description": "The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).", "type": "string", "minLength": 0, "maxLength": 100, "pattern": "^.*$" }, "method": { "description": "The HTTP method required to make the related call.", "type": "string", "minLength": 3, "maxLength": 6, "pattern": "^[A-Z]*$", "enum": ["GET", "POST", "PUT", "DELETE", "PATCH"] } } }, "error_location": { "type": "string", "description": "The location of the field that caused the error. Value is `body`, `path`, or `query`.", "enum": ["body", "path", "query"], "default": "body" }, "exchange_rate": { "description": "The exchange rate that determines the amount to convert from one currency to another currency.", "type": "object", "title": "Exchange Rate", "properties": { "source_currency": { "description": "The source currency from which to convert an amount.", "$ref": "#/components/schemas/currency_code" }, "target_currency": { "description": "The target currency to which to convert an amount.", "$ref": "#/components/schemas/currency_code" }, "value": { "description": "The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point.", "type": "string" } }, "readOnly": true }, "experience_context_base": { "type": "object", "title": "Experience Context Base", "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-Z_]+$", "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" } } }, "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", "description": "The full name representation like Mr J Smith.", "minLength": 3, "maxLength": 300 }, "giropay": { "type": "object", "title": "Giropay payment object", "description": "Information needed to pay using giropay.", "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" }, "bic": { "description": "The bank identification code (BIC).", "$ref": "#/components/schemas/bic" } } }, "giropay_request": { "type": "object", "title": "Giropay payment request", "description": "Information needed to pay using giropay.", "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_base" } }, "required": ["name", "country_code"] }, "google_pay": { "type": "object", "title": "Google Pay Wallet Response", "description": "Google Pay Wallet payment data.", "properties": { "name": { "description": "Name on the account holder associated with Google Pay.", "$ref": "#/components/schemas/full_name" }, "email_address": { "description": "The email address of the account holder associated with Google Pay.", "$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"] }, "card": { "description": "The Card from Google Pay Wallet used to fund the payment.", "$ref": "#/components/schemas/google_pay_card_response" } } }, "google_pay_attributes": {}, "google_pay_card_response": { "type": "object", "title": "Google Pay Card Response", "description": "The payment card to use to fund a Google Pay payment response. 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}$" }, "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:@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
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": "The detailed item description.",
"maxLength": 2048
},
"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_list": {
"type": "array",
"description": "An array of items that the customer purchases from the merchant.",
"items": {
"$ref": "#/components/schemas/item"
}
},
"labels": {
"type": "string",
"description": "Label for the cobranded card.",
"minLength": 1,
"maxLength": 256
},
"labels_list": {
"type": "array",
"description": "Array of labels for the cobranded card.",
"minItems": 1,
"maxItems": 25,
"items": {
"$ref": "#/components/schemas/labels"
}
},
"language": {
"type": "string",
"description": "The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).",
"format": "ppaas_common_language_v3",
"maxLength": 10,
"minLength": 2,
"pattern": "^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$"
},
"level_2_card_processing_data": {
"type": "object",
"title": "Level 2 Card Processing Data",
"description": "The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business.",
"properties": {
"invoice_id": {
"type": "string",
"description": "Use this field to pass a purchase identification value of up to 127 ASCII characters. The length of this field will be adjusted to meet network specifications (25chars for Visa and Mastercard, 17chars for Amex), and the original invoice ID will still be displayed in your existing reports.",
"minLength": 1,
"maxLength": 127,
"pattern": "^[\\w‘\\-.,\":;\\!?]*$"
},
"tax_total": {
"description": "Use this field to break down the amount of tax included in the total purchase amount. The value provided here will not add to the total purchase amount. The value can't be negative, and in most cases, it must be greater than zero in order to qualify for lower interchange rates. \n Value, by country, is:\n\n UK. A county.\n US. A state.\n Canada. A province.\n Japan. A prefecture.\n Switzerland. A kanton.\n",
"$ref": "#/components/schemas/money"
}
}
},
"level_3_card_processing_data": {
"type": "object",
"title": "Level 3 Card Processing Data",
"description": "The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business.",
"properties": {
"shipping_amount": {
"description": "Use this field to break down the shipping cost included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.",
"$ref": "#/components/schemas/money"
},
"duty_amount": {
"description": "Use this field to break down the duty amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.",
"$ref": "#/components/schemas/money"
},
"discount_amount": {
"description": "Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.",
"$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: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. Must equal tax * quantity for all items. tax.value can not be a negative number.",
"$ref": "#/components/schemas/money"
},
"commodity_code": {
"type": "string",
"description": "Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used.",
"minLength": 1,
"maxLength": 12,
"pattern": "^[a-zA-Z0-9_'.-]*$"
},
"discount_amount": {
"description": "Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.",
"$ref": "#/components/schemas/money"
},
"total_amount": {
"description": "The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number.",
"$ref": "#/components/schemas/money"
},
"unit_of_measure": {
"type": "string",
"description": "Unit of measure is a standard used to express the magnitude of a quantity in international trade. Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK).",
"minLength": 1,
"maxLength": 12,
"pattern": "^[a-zA-Z0-9_'.-]*$"
}
},
"required": ["name", "quantity"]
},
"line_item_list": {
"type": "array",
"description": "A list of the items that were purchased with this payment. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf.",
"minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/line_item"
}
},
"link_description": {
"type": "object",
"title": "Link Description",
"description": "The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information.",
"required": ["href", "rel"],
"properties": {
"href": {
"type": "string",
"description": "The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call."
},
"rel": {
"type": "string",
"description": "The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml)."
},
"method": {
"type": "string",
"description": "The HTTP method required to make the related call.",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"HEAD",
"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."
}
}
}
},
"link_description_list": {
"type": "array",
"description": "An array of request-related HATEOAS links.",
"readOnly": true,
"minItems": 1,
"maxItems": 10,
"items": {
"$ref": "#/components/schemas/link_description"
}
},
"merchant_partner_customer_id": {
"type": "string",
"description": "The unique ID for a customer generated by PayPal.",
"minLength": 1,
"maxLength": 22,
"pattern": "^[0-9a-zA-Z_-]+$"
},
"money": {
"type": "object",
"title": "Money",
"description": "The currency and amount for a financial transaction, such as a balance or payment due.",
"properties": {
"currency_code": {
"$ref": "#/components/schemas/currency_code"
},
"value": {
"type": "string",
"description": "The value, which might be:Note: Partners and Marketplaces might configure", "properties": { "brand_name": { "type": "string", "description": "DEPRECATED. The label that overrides the business name in the PayPal account on the PayPal site. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.brand_name`). Please specify this field in the `experience_context` object instead of the `application_context` object.", "minLength": 1, "maxLength": 127 }, "locale": { "description": "DEPRECATED. 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`. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.locale`). Please specify this field in the `experience_context` object instead of the `application_context` object.", "$ref": "#/components/schemas/language" }, "landing_page": { "title": "Order Application Context Landing Page", "type": "string", "description": "DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site for customer checkout. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.landing_page`). Please specify this field in the `experience_context` object instead of the `application_context` object.", "deprecated": true, "default": "NO_PREFERENCE", "x-enumDescriptions": [ { "value": "LOGIN", "description": "When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment." }, { "value": "BILLING", "description": "When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase." }, { "value": "NO_PREFERENCE", "description": "When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal." } ], "minLength": 1, "maxLength": 13, "pattern": "^[0-9A-Z_]+$", "enum": ["LOGIN", "BILLING", "NO_PREFERENCE"] }, "shipping_preference": { "title": "Order Application Context Shipping Preference", "type": "string", "description": "DEPRECATED. DEPRECATED. The shipping preference:brand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
final_capture = true for all purchase units within the order."
},
{
"value": "APPROVED",
"description": "The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on."
},
{
"value": "VOIDED",
"description": "All purchase units in the order are voided."
},
{
"value": "COMPLETED",
"description": "The intent of the order was completed and a `payments` resource was created. Important: Check the payment status in `purchase_units[].payments.captures[].status` before fulfilling the order. A completed order can indicate a payment was authorized, an authorized payment was captured, or a payment was declined."
},
{
"value": "PAYER_ACTION_REQUIRED",
"description": "The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the \"rel\":\"payer-action\" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc)."
}
],
"enum": [
"CREATED",
"SAVED",
"APPROVED",
"VOIDED",
"COMPLETED",
"PAYER_ACTION_REQUIRED"
]
},
"order_tracker_request": {
"type": "object",
"title": "Order Tracker Request.",
"description": "The tracking details of an order.",
"properties": {
"tracking_number": {
"type": "string",
"description": "The tracking number for the shipment. This property supports Unicode.",
"minLength": 1,
"maxLength": 64
},
"carrier": {
"$ref": "#/components/schemas/shipment_carrier"
},
"carrier_name_other": {
"type": "string",
"description": "The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.",
"minLength": 1,
"maxLength": 64
},
"capture_id": {
"type": "string",
"description": "The PayPal capture ID.",
"minLength": 1,
"maxLength": 50,
"pattern": "^[a-zA-Z0-9]*$"
},
"notify_payer": {
"type": "boolean",
"description": "If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for `notify_payer`, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences.",
"default": false
},
"items": {
"$ref": "#/components/schemas/tracker_item_list"
}
},
"required": ["capture_id"]
},
"order_update_callback_request": {
"title": "OrderUpdateCallbackRequest",
"type": "object",
"description": "Shipping Options Callback request. This will be implemented by the merchants.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the order.",
"readOnly": true,
"minLength": 1,
"maxLength": 36,
"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:value parameter defines the value to add. For more information, see 4.1. add."
},
{
"value": "remove",
"description": "Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove."
},
{
"value": "replace",
"description": "Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace."
},
{
"value": "move",
"description": "Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move."
},
{
"value": "copy",
"description": "Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy."
},
{
"value": "test",
"description": "Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:| Type | Considered equal if both values |
|---|---|
| strings | Contain the same number of Unicode characters and their code points are byte-by-byte equal. |
| numbers | Are numerically equal. |
| arrays | Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules. |
| objects | Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules). |
literals (false, true, and null) | Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant. |
remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified."
},
"from": {
"type": "string",
"description": "The JSON Pointer to the target document location from which to move the value. Required for the move operation."
}
},
"required": ["op"]
},
"patch_request": {
"type": "array",
"title": "Patch Request",
"description": "An array of JSON patch objects to apply partial updates to resources.",
"minItems": 0,
"maxItems": 32767,
"items": {
"$ref": "#/components/schemas/patch"
}
},
"payee": {
"type": "object",
"title": "Payee",
"description": "The merchant who receives the funds and fulfills the order. The merchant is also known as the payee.",
"allOf": [
{
"$ref": "#/components/schemas/payee_base"
},
{
"properties": {}
}
]
},
"payee_base": {
"type": "object",
"title": "Payee Base",
"description": "The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.",
"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"
}
}
},
"payee_payment_method_preference": {
"type": "string",
"description": "The merchant-preferred payment methods.",
"minLength": 1,
"maxLength": 255,
"pattern": "^[0-9A-Z_]+$",
"default": "UNRESTRICTED",
"x-enumDescriptions": [
{
"value": "UNRESTRICTED",
"description": "Accepts any type of payment from the customer.",
"default": true
},
{
"value": "IMMEDIATE_PAYMENT_REQUIRED",
"description": "Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status."
}
],
"enum": ["UNRESTRICTED", "IMMEDIATE_PAYMENT_REQUIRED"]
},
"payer": {
"allOf": [
{
"$ref": "#/components/schemas/payer_base"
},
{
"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
}
}
},
"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`.",
"$ref": "#/components/schemas/phone_with_type"
},
"birth_date": {
"description": "The birth date of the payer in `YYYY-MM-DD` format.",
"$ref": "#/components/schemas/date_no_time"
},
"tax_info": {
"description": "The tax information of the payer. Required only for Brazilian payer's. Both `tax_id` and `tax_id_type` are required.",
"$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:Note: Partners and Marketplaces might configure", "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-Z_]+$", "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": "Removes the shipping address information from the API response and the Paypal site. However, the shipping.phone_number and shipping.email_address fields will still be returned to allow for digital goods delivery." }, { "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"] }, "contact_preference": { "type": "string", "description": "The preference to display the contact information (buyer’s shipping email & phone number) on PayPal's checkout for easy merchant-buyer communication.", "minLength": 1, "maxLength": 24, "pattern": "^[A-Z_]+$", "default": "NO_CONTACT_INFO", "x-enumDescriptions": [ { "value": "NO_CONTACT_INFO", "description": "The merchant can opt out of showing buyer's contact information on PayPal checkout." }, { "value": "UPDATE_CONTACT_INFO", "description": "The merchant allows buyer to add or update shipping contact information on the PayPal checkout. Please ensure to use this updated information returned in shipping.email_address and shipping.phone_number to contact your buyers." }, { "value": "RETAIN_CONTACT_INFO", "description": "The buyer can only see but can not override merchant passed contact information (shipping.email_address and shipping.phone_number) on PayPal checkout. NOTE: If you don't pass the contact information, the behavior is the same as NO_CONTACT_INFO preference." } ], "enum": [ "NO_CONTACT_INFO", "UPDATE_CONTACT_INFO", "RETAIN_CONTACT_INFO" ] }, "return_url": { "description": "The URL where the customer will be redirected upon approving a payment.", "format": "uri", "$ref": "#/components/schemas/url" }, "cancel_url": { "description": "The URL where the customer will be redirected upon cancelling the payment approval.", "format": "uri", "$ref": "#/components/schemas/url" }, "landing_page": { "type": "string", "description": "The type of landing page to show on the PayPal site for customer checkout.", "default": "NO_PREFERENCE", "x-enumDescriptions": [ { "value": "LOGIN", "description": "When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment." }, { "value": "GUEST_CHECKOUT", "description": "When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase. This option has previously been also called as 'BILLING'" }, { "value": "NO_PREFERENCE", "description": "When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal." } ], "minLength": 1, "maxLength": 13, "pattern": "^[0-9A-Z_]+$", "enum": ["LOGIN", "GUEST_CHECKOUT", "NO_PREFERENCE"] }, "user_action": { "type": "string", "description": "Configures a Continue or Pay Now checkout flow.", "default": "CONTINUE", "x-enumDescriptions": [ { "value": "CONTINUE", "description": "After you redirect the customer to the PayPal payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.", "default": true }, { "value": "PAY_NOW", "description": "After you redirect the customer to the PayPal payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now." } ], "minLength": 1, "maxLength": 8, "pattern": "^[0-9A-Z_]+$", "enum": ["CONTINUE", "PAY_NOW"] }, "payment_method_preference": { "type": "string", "description": "The merchant-preferred payment methods.", "minLength": 1, "maxLength": 255, "pattern": "^[0-9A-Z_]+$", "default": "UNRESTRICTED", "x-enumDescriptions": [ { "value": "UNRESTRICTED", "description": "Accepts any type of payment from the customer.", "default": true }, { "value": "IMMEDIATE_PAYMENT_REQUIRED", "description": "Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status." } ], "enum": ["UNRESTRICTED", "IMMEDIATE_PAYMENT_REQUIRED"] }, "order_update_callback_config": { "description": "Merchant provided Order Update callback configuration for PayPal Wallet.PayPal will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when `shipping.type` is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.", "$ref": "#/components/schemas/callback_configuration" } } }, "paypal_wallet_response": { "type": "object", "title": "PayPal Wallet Response", "description": "The PayPal Wallet response.", "properties": { "email_address": { "description": "The email address of the PayPal account holder.", "$ref": "#/components/schemas/email" }, "account_id": { "description": "The PayPal-assigned ID for the PayPal account holder.", "readOnly": true, "$ref": "#/components/schemas/account_id-2" }, "account_status": { "type": "string", "description": "The account status indicates whether the buyer has verified the financial details associated with their PayPal account.", "readOnly": true, "minLength": 1, "maxLength": 255, "pattern": "^[A-Z_]+$", "x-enumDescriptions": [ { "value": "VERIFIED", "description": "The buyer has completed the verification of the financial details associated with this PayPal account. For example: confirming their bank account." }, { "value": "UNVERIFIED", "description": "The buyer has not completed the verification of the financial details associated with this PayPal account. For example: confirming their bank account." } ], "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 } } }, "phone_type": { "$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). Available only when you enable the **Contact Telephone Number** option in the **Profile & Settings** for the merchant's PayPal account. Supports only the `national_number` property.", "$ref": "#/components/schemas/phone" }, "birth_date": { "description": "The birth date of the PayPal account holder in `YYYY-MM-DD` format.", "$ref": "#/components/schemas/date_no_time" }, "business_name": { "description": "The business name of the PayPal account holder (populated for business accounts only)", "type": "string", "minLength": 0, "maxLength": 300, "pattern": "^.*$" }, "tax_info": { "description": "The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both `tax_id` and `tax_id_type` are required.", "$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:brand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
Note: If there are multiple purchase units, reference_id is required for each purchase unit.",
"minLength": 1,
"maxLength": 256
},
"amount": {
"$ref": "#/components/schemas/amount_with_breakdown"
},
"payee": {
"description": "The merchant who receives payment for this transaction.",
"$ref": "#/components/schemas/payee"
},
"payment_instruction": {
"$ref": "#/components/schemas/payment_instruction"
},
"description": {
"type": "string",
"description": "The purchase description.",
"minLength": 1,
"maxLength": 127
},
"custom_id": {
"type": "string",
"description": "The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.",
"minLength": 1,
"maxLength": 255
},
"invoice_id": {
"type": "string",
"description": "The API caller-provided external invoice ID for this order.",
"minLength": 1,
"maxLength": 127
},
"id": {
"type": "string",
"description": "The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives. In addition, this ID is available in transaction and settlement reports that merchants and API callers can use to reconcile transactions. This ID is only available when an order is saved by calling v2/checkout/orders/id/save.",
"minLength": 1,
"maxLength": 19
},
"soft_descriptor": {
"type": "string",
"description": "The payment descriptor on account transactions on the customer's credit card statement, that PayPal sends to processors. The maximum length of the soft descriptor information that you can pass in the API field is 22 characters, in the following format:22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters.PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptorNote: 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/editThe
PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. PAYPAL *.Janes Gift.800-123-1234.PAYPAL * Janes Gift 80.",
"minLength": 1,
"maxLength": 22
},
"items": {
"$ref": "#/components/schemas/item_list"
},
"shipping": {
"description": "The name and address of the person to whom to ship the items.",
"$ref": "#/components/schemas/shipping_detail"
},
"supplementary_data": {
"description": "Contains Supplementary Data.",
"$ref": "#/components/schemas/supplementary_data"
}
},
"required": ["amount"]
},
"purchase_unit_request_list": {
"type": "array",
"description": "An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.",
"minItems": 1,
"maxItems": 10,
"items": {
"$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",
"description": "The refund information.",
"allOf": [
{
"$ref": "#/components/schemas/refund_status"
},
{
"properties": {
"id": {
"description": "The PayPal-generated ID for the refund.",
"type": "string",
"readOnly": true
},
"amount": {
"description": "The amount that the payee refunded to the payer.",
"$ref": "#/components/schemas/money",
"readOnly": true
},
"invoice_id": {
"description": "The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.",
"type": "string",
"readOnly": true
},
"custom_id": {
"type": "string",
"description": "The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.",
"minLength": 1,
"maxLength": 255,
"pattern": "^[A-Za-z0-9-_.,]*$"
},
"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]+$"
},
"note_to_payer": {
"description": "The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.",
"type": "string",
"readOnly": true
},
"seller_payable_breakdown": {
"$ref": "#/components/schemas/seller_payable_breakdown"
},
"payer": {
"description": "The details associated with the merchant for this transaction.",
"$ref": "#/components/schemas/payee_base",
"readOnly": true
},
"links": {
"$ref": "#/components/schemas/refund_definitions-link_description_list"
}
}
},
{
"$ref": "#/components/schemas/activity_timestamps"
}
]
},
"refund_definitions-link_description_list": {
"description": "An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/link_description"
}
},
"refund_definitions-platform_fee_list": {
"type": "array",
"description": "An array of platform or partner fees, commissions, or brokerage fees for the refund.",
"minItems": 0,
"maxItems": 1,
"items": {
"$ref": "#/components/schemas/platform_fee"
}
},
"refund_list": {
"type": "array",
"description": "An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.",
"items": {
"$ref": "#/components/schemas/refund"
}
},
"refund_status": {
"type": "object",
"description": "The refund status with details.",
"title": "Refund Status With Details",
"properties": {
"status": {
"title": "Refund Status With Details",
"description": "The status of the refund.",
"type": "string",
"x-enumDescriptions": [
{
"value": "CANCELLED",
"description": "The refund was cancelled."
},
{
"value": "FAILED",
"description": "The refund could not be processed."
},
{
"value": "PENDING",
"description": "The refund is pending. For more information, see status_details.reason."
},
{
"value": "COMPLETED",
"description": "The funds for this transaction were debited to the customer's account."
}
],
"readOnly": true,
"enum": ["CANCELLED", "FAILED", "PENDING", "COMPLETED"]
},
"status_details": {
"description": "The details of the refund status.",
"readOnly": true,
"$ref": "#/components/schemas/refund_status_details"
}
}
},
"refund_status_details": {
"title": "Refund Status Details",
"description": "The details of the refund status.",
"type": "object",
"properties": {
"reason": {
"title": "Refund Incomplete Reason",
"description": "The reason why the refund has the `PENDING` or `FAILED` status.",
"type": "string",
"x-enumDescriptions": [
{
"value": "ECHECK",
"description": "The customer's account is funded through an eCheck, which has not yet cleared."
}
],
"enum": ["ECHECK"]
}
}
},
"risk_supplementary_data": {
"type": "object",
"title": "Risk Supplementary Data",
"description": "Additional information necessary to evaluate the risk profile of a transaction.",
"properties": {
"customer": {
"$ref": "#/components/schemas/participant_metadata"
}
}
},
"seller_payable_breakdown": {
"description": "The breakdown of the refund.",
"type": "object",
"title": "Seller Payable Breakdown",
"properties": {
"gross_amount": {
"description": "The amount that the payee refunded to the payer.",
"$ref": "#/components/schemas/money",
"readOnly": true
},
"paypal_fee": {
"description": "The PayPal fee that was refunded to the payer in the currency of the transaction. This fee might not match the PayPal fee that the payee paid when the payment was captured.",
"$ref": "#/components/schemas/money",
"readOnly": true
},
"paypal_fee_in_receivable_currency": {
"description": "The PayPal fee that was refunded to the payer in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.",
"$ref": "#/components/schemas/money",
"readOnly": true
},
"net_amount": {
"description": "The net amount that the payee's account is debited in the transaction currency. The net amount is calculated as gross_amount minus paypal_fee minus platform_fees.",
"$ref": "#/components/schemas/money",
"readOnly": true
},
"net_amount_in_receivable_currency": {
"description": "The net amount that the payee's account is debited in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.",
"$ref": "#/components/schemas/money",
"readOnly": true
},
"platform_fees": {
"$ref": "#/components/schemas/refund_definitions-platform_fee_list"
},
"net_amount_breakdown": {
"$ref": "#/components/schemas/net_amount_breakdown_item_list"
},
"total_refunded_amount": {
"description": "The total amount refunded from the original capture to date. For example, if a payer makes a $100 purchase and was refunded $20 a week ago and was refunded $30 in this refund, the `gross_amount` is $30 for this refund and the `total_refunded_amount` is $50.",
"$ref": "#/components/schemas/money"
}
},
"readOnly": true
},
"seller_protection": {
"type": "object",
"description": "The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection).",
"title": "Seller Protection",
"properties": {
"status": {
"title": "Seller Protection Status",
"type": "string",
"description": "Indicates whether the transaction is eligible for seller protection. For information, see [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection).",
"x-enumDescriptions": [
{
"value": "ELIGIBLE",
"description": "Your PayPal balance remains intact if the customer claims that they did not receive an item or the account holder claims that they did not authorize the payment."
},
{
"value": "PARTIALLY_ELIGIBLE",
"description": "Your PayPal balance remains intact if the customer claims that they did not receive an item."
},
{
"value": "NOT_ELIGIBLE",
"description": "This transaction is not eligible for seller protection."
}
],
"readOnly": true,
"enum": ["ELIGIBLE", "PARTIALLY_ELIGIBLE", "NOT_ELIGIBLE"]
},
"dispute_categories": {
"$ref": "#/components/schemas/dispute_categories_list"
}
}
},
"seller_receivable_breakdown": {
"type": "object",
"title": "Seller Receivable Breakdown",
"description": "The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.",
"properties": {
"gross_amount": {
"description": "The amount for this captured payment in the currency of the transaction.",
"$ref": "#/components/schemas/money"
},
"paypal_fee": {
"description": "The applicable fee for this captured payment in the currency of the transaction.",
"$ref": "#/components/schemas/money"
},
"paypal_fee_in_receivable_currency": {
"description": "The applicable fee for this captured payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example 'CNY'.",
"$ref": "#/components/schemas/money"
},
"net_amount": {
"description": "The net amount that the payee receives for this captured payment in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee minus the platform_fees.",
"$ref": "#/components/schemas/money"
},
"receivable_amount": {
"description": "The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. The amount is computed as net_amount times exchange_rate.",
"$ref": "#/components/schemas/money"
},
"exchange_rate": {
"description": "The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.",
"$ref": "#/components/schemas/exchange_rate"
},
"platform_fees": {
"$ref": "#/components/schemas/definitions-platform_fee_list"
}
},
"required": ["gross_amount"]
},
"shipment_carrier": {
"type": "string",
"title": "Carrier.",
"description": "The carrier for the shipment. 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": "^[0-9A-Z_]+$",
"x-enumDescriptions": [
{
"value": "DPD_RU",
"description": "DPD Russia."
},
{
"value": "BG_BULGARIAN_POST",
"description": "Bulgarian Posts."
},
{
"value": "KR_KOREA_POST",
"description": "Koreapost (www.koreapost.go.kr)."
},
{
"value": "ZA_COURIERIT",
"description": "Courier IT."
},
{
"value": "FR_EXAPAQ",
"description": "DPD France (formerly exapaq)."
},
{
"value": "ARE_EMIRATES_POST",
"description": "Emirates Post."
},
{
"value": "GAC",
"description": "GAC."
},
{
"value": "GEIS",
"description": "Geis CZ."
},
{
"value": "SF_EX",
"description": "SF Express."
},
{
"value": "PAGO",
"description": "Pago Logistics."
},
{
"value": "MYHERMES",
"description": "MyHermes UK."
},
{
"value": "DIAMOND_EUROGISTICS",
"description": "Diamond Eurogistics Limited."
},
{
"value": "CORPORATECOURIERS_WEBHOOK",
"description": "Corporate Couriers."
},
{
"value": "BOND",
"description": "Bond courier."
},
{
"value": "OMNIPARCEL",
"description": "Omni Parcel."
},
{
"value": "SK_POSTA",
"description": "Slovenska pošta."
},
{
"value": "PUROLATOR",
"description": "purolator."
},
{
"value": "FETCHR_WEBHOOK",
"description": "Mena 360 (Fetchr)."
},
{
"value": "THEDELIVERYGROUP",
"description": "TDG – The Delivery Group."
},
{
"value": "CELLO_SQUARE",
"description": "Cello Square."
},
{
"value": "TARRIVE",
"description": "TONDA GLOBAL."
},
{
"value": "COLLIVERY",
"description": "MDS Collivery Pty (Ltd)."
},
{
"value": "MAINFREIGHT",
"description": "Mainfreight."
},
{
"value": "IND_FIRSTFLIGHT",
"description": "First Flight Couriers."
},
{
"value": "ACSWORLDWIDE",
"description": "ACS Worldwide Express."
},
{
"value": "AMSTAN",
"description": "Amstan Logistics."
},
{
"value": "OKAYPARCEL",
"description": "OkayParcel."
},
{
"value": "ENVIALIA_REFERENCE",
"description": "Envialia Reference."
},
{
"value": "SEUR_ES",
"description": "Seur Spain."
},
{
"value": "CONTINENTAL",
"description": "Continental."
},
{
"value": "FDSEXPRESS",
"description": "FDSEXPRESS."
},
{
"value": "AMAZON_FBA_SWISHIP",
"description": "Swiship UK."
},
{
"value": "WYNGS",
"description": "Wyngs."
},
{
"value": "DHL_ACTIVE_TRACING",
"description": "DHL Active Tracing."
},
{
"value": "ZYLLEM",
"description": "Zyllem."
},
{
"value": "RUSTON",
"description": "Ruston."
},
{
"value": "XPOST",
"description": "Xpost.ph."
},
{
"value": "CORREOS_ES",
"description": "correos Express (www.correos.es)."
},
{
"value": "DHL_FR",
"description": "DHL France (www.dhl.com)."
},
{
"value": "PAN_ASIA",
"description": "Pan-Asia International."
},
{
"value": "BRT_IT",
"description": "BRT couriers Italy (www.brt.it)."
},
{
"value": "SRE_KOREA",
"description": "SRE Korea (www.srekorea.co.kr)."
},
{
"value": "SPEEDEE",
"description": "Spee-Dee Delivery."
},
{
"value": "TNT_UK",
"description": "TNT UK Limited (www.tnt.com)."
},
{
"value": "VENIPAK",
"description": "Venipak."
},
{
"value": "SHREENANDANCOURIER",
"description": "SHREE NANDAN COURIER."
},
{
"value": "CROSHOT",
"description": "Croshot."
},
{
"value": "NIPOST_NG",
"description": "NIpost (www.nipost.gov.ng)."
},
{
"value": "EPST_GLBL",
"description": "ePost Global."
},
{
"value": "NEWGISTICS",
"description": "Newgistics."
},
{
"value": "POST_SLOVENIA",
"description": "Post of Slovenia."
},
{
"value": "JERSEY_POST",
"description": "Jersey Post."
},
{
"value": "BOMBINOEXP",
"description": "Bombino Express Pvt."
},
{
"value": "WMG",
"description": "WMG Delivery."
},
{
"value": "XQ_EXPRESS",
"description": "XQ Express."
},
{
"value": "FURDECO",
"description": "Furdeco."
},
{
"value": "LHT_EXPRESS",
"description": "LHT Express."
},
{
"value": "SOUTH_AFRICAN_POST_OFFICE",
"description": "South African Post Office."
},
{
"value": "SPOTON",
"description": "SPOTON Logistics Pvt Ltd."
},
{
"value": "DIMERCO",
"description": "Dimerco Express Group."
},
{
"value": "CYPRUS_POST_CYP",
"description": "cyprus post."
},
{
"value": "ABCUSTOM",
"description": "AB Custom Group."
},
{
"value": "IND_DELIVREE",
"description": "deliverE."
},
{
"value": "CN_BESTEXPRESS",
"description": "Best Express."
},
{
"value": "DX_SFTP",
"description": "DX (SFTP)."
},
{
"value": "PICKUPP_MYS",
"description": "PICK UPP."
},
{
"value": "FMX",
"description": "FMX."
},
{
"value": "HELLMANN",
"description": "Hellmann Worldwide Logistics."
},
{
"value": "SHIP_IT_ASIA",
"description": "Ship It Asia."
},
{
"value": "KERRY_ECOMMERCE",
"description": "Kerry eCommerce."
},
{
"value": "FRETERAPIDO",
"description": "Frete Rapido."
},
{
"value": "PITNEY_BOWES",
"description": "Pitney Bowes."
},
{
"value": "XPRESSEN_DK",
"description": "Xpressen courier."
},
{
"value": "SEUR_SP_API",
"description": "Spanish Seur API."
},
{
"value": "DELIVERYONTIME",
"description": "DELIVERYONTIME LOGISTICS PVT LTD."
},
{
"value": "JINSUNG",
"description": "JINSUNG TRADING."
},
{
"value": "TRANS_KARGO",
"description": "Trans Kargo Internasional."
},
{
"value": "SWISHIP_DE",
"description": "Swiship DE."
},
{
"value": "IVOY_WEBHOOK",
"description": "Ivoy courier."
},
{
"value": "AIRMEE_WEBHOOK",
"description": "Airmee couriers."
},
{
"value": "DHL_BENELUX",
"description": "dhl benelux."
},
{
"value": "FIRSTMILE",
"description": "FirstMile."
},
{
"value": "FASTWAY_IR",
"description": "Fastway Ireland."
},
{
"value": "HH_EXP",
"description": "Hua Han Logistics."
},
{
"value": "MYS_MYPOST_ONLINE",
"description": "Mypostonline."
},
{
"value": "TNT_NL",
"description": "THT Netherland."
},
{
"value": "TIPSA",
"description": "TIPSA courier."
},
{
"value": "TAQBIN_MY",
"description": "TAQBIN Malaysia."
},
{
"value": "KGMHUB",
"description": "KGM Hub."
},
{
"value": "INTEXPRESS",
"description": "Internet Express."
},
{
"value": "OVERSE_EXP",
"description": "Overseas Express."
},
{
"value": "ONECLICK",
"description": "One click delivery services."
},
{
"value": "ROADRUNNER_FREIGHT",
"description": "Roadbull Logistics."
},
{
"value": "GLS_CROTIA",
"description": "GLS Croatia."
},
{
"value": "MRW_FTP",
"description": "MRW courier."
},
{
"value": "BLUEX",
"description": "Blue Express."
},
{
"value": "DYLT",
"description": "Daylight Transport."
},
{
"value": "DPD_IR",
"description": "DPD Ireland."
},
{
"value": "SIN_GLBL",
"description": "Sin Global Express."
},
{
"value": "TUFFNELLS_REFERENCE",
"description": "Tuffnells Parcels Express- Reference."
},
{
"value": "CJPACKET",
"description": "CJ Packet."
},
{
"value": "MILKMAN",
"description": "Milkman courier."
},
{
"value": "ASIGNA",
"description": "ASIGNA courier."
},
{
"value": "ONEWORLDEXPRESS",
"description": "One World Express."
},
{
"value": "ROYAL_MAIL",
"description": "RoyalShipments."
},
{
"value": "VIA_EXPRESS",
"description": "Viaxpress."
},
{
"value": "TIGFREIGHT",
"description": "TIG Freight."
},
{
"value": "ZTO_EXPRESS",
"description": "ZTO Express."
},
{
"value": "TWO_GO",
"description": "2GO Courier."
},
{
"value": "IML",
"description": "IML courier."
},
{
"value": "INTEL_VALLEY",
"description": "Intel-Valley Supply chain (ShenZhen) Co. Ltd."
},
{
"value": "EFS",
"description": "EFS (E-commerce Fulfillment Service)."
},
{
"value": "UK_UK_MAIL",
"description": "UK mail (ukmail.com)."
},
{
"value": "RAM",
"description": "RAM courier."
},
{
"value": "ALLIEDEXPRESS",
"description": "Allied Express."
},
{
"value": "APC_OVERNIGHT",
"description": "APC overnight (apc-overnight.com)."
},
{
"value": "SHIPPIT",
"description": "Shippit."
},
{
"value": "TFM",
"description": "TFM Xpress."
},
{
"value": "M_XPRESS",
"description": "M Xpress Sdn Bhd."
},
{
"value": "HDB_BOX",
"description": "Haidaibao (BOX)."
},
{
"value": "CLEVY_LINKS",
"description": "Clevy Links."
},
{
"value": "IBEONE",
"description": "Beone Logistics."
},
{
"value": "FIEGE_NL",
"description": "Fiege Netherlands."
},
{
"value": "KWE_GLOBAL",
"description": "KWE Global."
},
{
"value": "CTC_EXPRESS",
"description": "CTC Express."
},
{
"value": "AMAZON",
"description": "Amazon Shipping."
},
{
"value": "MORE_LINK",
"description": "Morelink."
},
{
"value": "JX",
"description": "JX courier."
},
{
"value": "EASY_MAIL",
"description": "Easy Mail."
},
{
"value": "ADUIEPYLE",
"description": "A Duie Pyle."
},
{
"value": "GB_PANTHER",
"description": "Panther."
},
{
"value": "EXPRESSSALE",
"description": "Expresssale."
},
{
"value": "SG_DETRACK",
"description": "Detrack."
},
{
"value": "TRUNKRS_WEBHOOK",
"description": "Trunkrs courier."
},
{
"value": "MATDESPATCH",
"description": "Matdespatch."
},
{
"value": "DICOM",
"description": "GLS Logistic Systems Canada Ltd./Dicom."
},
{
"value": "MBW",
"description": "MBW Courier Inc.."
},
{
"value": "KHM_CAMBODIA_POST",
"description": "Cambodia Post."
},
{
"value": "SINOTRANS",
"description": "Sinotrans."
},
{
"value": "BRT_IT_PARCELID",
"description": "BRT Bartolini(Parcel ID)."
},
{
"value": "DHL_SUPPLY_CHAIN",
"description": "DHL Supply Chain APAC."
},
{
"value": "DHL_PL",
"description": "DHL Poland."
},
{
"value": "TOPYOU",
"description": "TopYou."
},
{
"value": "PALEXPRESS",
"description": "PAL Express Limited."
},
{
"value": "DHL_SG",
"description": "dhl Singapore."
},
{
"value": "CN_WEDO",
"description": "WeDo Logistics."
},
{
"value": "FULFILLME",
"description": "Fulfillme."
},
{
"value": "DPD_DELISTRACK",
"description": "DPD delistrack."
},
{
"value": "UPS_REFERENCE",
"description": "UPS Reference."
},
{
"value": "CARIBOU",
"description": "Caribou."
},
{
"value": "LOCUS_WEBHOOK",
"description": "Locus courier."
},
{
"value": "DSV",
"description": "DSV courier."
},
{
"value": "P2P_TRC",
"description": "P2P TrakPak."
},
{
"value": "DIRECTPARCELS",
"description": "Direct Parcels."
},
{
"value": "NOVA_POSHTA_INT",
"description": "Nova Poshta (International)."
},
{
"value": "FEDEX_POLAND",
"description": "FedEx® Poland Domestic."
},
{
"value": "CN_JCEX",
"description": "JCEX courier."
},
{
"value": "FAR_INTERNATIONAL",
"description": "FAR international."
},
{
"value": "IDEXPRESS",
"description": "IDEX courier."
},
{
"value": "GANGBAO",
"description": "GANGBAO Supplychain."
},
{
"value": "NEWAY",
"description": "Neway Transport."
},
{
"value": "POSTNL_INT_3_S",
"description": "PostNL International."
},
{
"value": "RPX_ID",
"description": "RPX Indonesia."
},
{
"value": "DESIGNERTRANSPORT_WEBHOOK",
"description": "Designer Transport."
},
{
"value": "GLS_SLOVEN",
"description": "GLS Slovenia."
},
{
"value": "PARCELLED_IN",
"description": "Parcelled.in."
},
{
"value": "GSI_EXPRESS",
"description": "GSI EXPRESS."
},
{
"value": "CON_WAY",
"description": "Con-way Freight."
},
{
"value": "BROUWER_TRANSPORT",
"description": "Brouwer Transport en Logistiek."
},
{
"value": "CPEX",
"description": "Captain Express International."
},
{
"value": "ISRAEL_POST",
"description": "Israel Post."
},
{
"value": "DTDC_IN",
"description": "DTDC India."
},
{
"value": "PTT_POST",
"description": "PTT Post."
},
{
"value": "XDE_WEBHOOK",
"description": "Ximex Delivery Express."
},
{
"value": "TOLOS",
"description": "Tolos courier."
},
{
"value": "GIAO_HANG",
"description": "Giao hàng nhanh."
},
{
"value": "GEODIS_ESPACE",
"description": "Geodis E-space."
},
{
"value": "MAGYAR_HU",
"description": "Magyar Post."
},
{
"value": "DOORDASH_WEBHOOK",
"description": "DoorDash."
},
{
"value": "TIKI_ID",
"description": "Tiki shipment."
},
{
"value": "CJ_HK_INTERNATIONAL",
"description": "CJ Logistics International(Hong Kong)."
},
{
"value": "STAR_TRACK_EXPRESS",
"description": "Star Track Express."
},
{
"value": "HELTHJEM",
"description": "Helthjem."
},
{
"value": "SFB2C",
"description": "SF International."
},
{
"value": "FREIGHTQUOTE",
"description": "Freightquote by C.H. Robinson."
},
{
"value": "LANDMARK_GLOBAL_REFERENCE",
"description": "Landmark Global Reference."
},
{
"value": "PARCEL2GO",
"description": "Parcel2Go."
},
{
"value": "DELNEXT",
"description": "Delnext."
},
{
"value": "RCL",
"description": "Red Carpet Logistics."
},
{
"value": "CGS_EXPRESS",
"description": "CGS Express."
},
{
"value": "HK_POST",
"description": "Hongkong Post (www.hongkongpost.hk)."
},
{
"value": "SAP_EXPRESS",
"description": "SAP EXPRESS."
},
{
"value": "PARCELPOST_SG",
"description": "Parcel Post Singapore."
},
{
"value": "HERMES",
"description": "HermesWorld UK."
},
{
"value": "IND_SAFEEXPRESS",
"description": "Safexpress."
},
{
"value": "TOPHATTEREXPRESS",
"description": "Tophatter Express."
},
{
"value": "MGLOBAL",
"description": "PT MGLOBAL LOGISTICS INDONESIA."
},
{
"value": "AVERITT",
"description": "Averitt Express."
},
{
"value": "LEADER",
"description": "leader."
},
{
"value": "_2EBOX",
"description": "2ebox courier."
},
{
"value": "SG_SPEEDPOST",
"description": "Singapore Speedpost."
},
{
"value": "DBSCHENKER_SE",
"description": "DB Schenker (www.dbschenker.com)."
},
{
"value": "ISR_POST_DOMESTIC",
"description": "Israel Post Domestic."
},
{
"value": "BESTWAYPARCEL",
"description": "Best Way Parcel."
},
{
"value": "ASENDIA_DE",
"description": "asendia_de."
},
{
"value": "NIGHTLINE_UK",
"description": "nightline_uk."
},
{
"value": "TAQBIN_SG",
"description": "taqbin_sg."
},
{
"value": "TCK_EXPRESS",
"description": "TCK Express."
},
{
"value": "ENDEAVOUR_DELIVERY",
"description": "Endeavour Delivery."
},
{
"value": "NANJINGWOYUAN",
"description": "Nanjing Woyuan."
},
{
"value": "HEPPNER_FR",
"description": "Heppner France."
},
{
"value": "EMPS_CN",
"description": "EMPS Express."
},
{
"value": "FONSEN",
"description": "Fonsen Logistics."
},
{
"value": "PICKRR",
"description": "Pickrr."
},
{
"value": "APC_OVERNIGHT_CONNUM",
"description": "APC Overnight Consignment."
},
{
"value": "STAR_TRACK_NEXT_FLIGHT",
"description": "Star Track Next Flight."
},
{
"value": "DAJIN",
"description": "Shanghai Aqrum Chemical Logistics Co.Ltd."
},
{
"value": "UPS_FREIGHT",
"description": "UPS Freight."
},
{
"value": "POSTA_PLUS",
"description": "Posta Plus."
},
{
"value": "CEVA",
"description": "CEVA LOGISTICS."
},
{
"value": "ANSERX",
"description": "ANSERX courier."
},
{
"value": "JS_EXPRESS",
"description": "JS EXPRESS."
},
{
"value": "PADTF",
"description": "padtf.com."
},
{
"value": "UPS_MAIL_INNOVATIONS",
"description": "UPS Mail Innovations."
},
{
"value": "SYPOST",
"description": "Sunyou Post."
},
{
"value": "AMAZON_SHIP_MCF",
"description": "Amazon Shipping + Amazon MCF."
},
{
"value": "YUSEN",
"description": "Yusen Logistics."
},
{
"value": "BRING",
"description": "Bring."
},
{
"value": "SDA_IT",
"description": "SDA Italy."
},
{
"value": "GBA",
"description": "GBA Services Ltd."
},
{
"value": "NEWEGGEXPRESS",
"description": "Newegg Express."
},
{
"value": "SPEEDCOURIERS_GR",
"description": "Speed Couriers."
},
{
"value": "FORRUN",
"description": "forrun Pvt Ltd (Arpatech Venture)."
},
{
"value": "PICKUP",
"description": "Pickupp."
},
{
"value": "ECMS",
"description": "ECMS International Logistics Co.."
},
{
"value": "INTELIPOST",
"description": "Intelipost (TMS for LATAM)."
},
{
"value": "FLASHEXPRESS",
"description": "Flash Express."
},
{
"value": "CN_STO",
"description": "STO Express."
},
{
"value": "SEKO_SFTP",
"description": "SEKO Worldwide."
},
{
"value": "HOME_DELIVERY_SOLUTIONS",
"description": "Home Delivery Solutions Ltd."
},
{
"value": "DPD_HGRY",
"description": "DPD Hungary."
},
{
"value": "KERRYTTC_VN",
"description": "Kerry Express (Vietnam) Co Ltd."
},
{
"value": "JOYING_BOX",
"description": "Joying Box."
},
{
"value": "TOTAL_EXPRESS",
"description": "Total Express."
},
{
"value": "ZJS_EXPRESS",
"description": "ZJS International."
},
{
"value": "STARKEN",
"description": "STARKEN couriers."
},
{
"value": "DEMANDSHIP",
"description": "DemandShip."
},
{
"value": "CN_DPEX",
"description": "DPEX."
},
{
"value": "AUPOST_CN",
"description": "AuPost China."
},
{
"value": "LOGISTERS",
"description": "Logisters."
},
{
"value": "GOGLOBALPOST",
"description": "Global Post."
},
{
"value": "GLS_CZ",
"description": "GLS Czech Republic."
},
{
"value": "PAACK_WEBHOOK",
"description": "Paack courier."
},
{
"value": "GRAB_WEBHOOK",
"description": "Grab courier."
},
{
"value": "PARCELPOINT",
"description": "Parcelpoint."
},
{
"value": "ICUMULUS",
"description": "iCumulus."
},
{
"value": "DAIGLOBALTRACK",
"description": "DAI Post."
},
{
"value": "GLOBAL_IPARCEL",
"description": "i-parcel."
},
{
"value": "YURTICI_KARGO",
"description": "Yurtici Kargo."
},
{
"value": "CN_PAYPAL_PACKAGE",
"description": "PayPal Package."
},
{
"value": "PARCEL_2_POST",
"description": "Parcel To Post."
},
{
"value": "GLS_IT",
"description": "GLS Italy."
},
{
"value": "PIL_LOGISTICS",
"description": "PIL Logistics (China) Co.."
},
{
"value": "HEPPNER",
"description": "Heppner Internationale Spedition GmbH & Co.."
},
{
"value": "GENERAL_OVERNIGHT",
"description": "Go!Express and logistics."
},
{
"value": "HAPPY2POINT",
"description": "Happy 2ThePoint."
},
{
"value": "CHITCHATS",
"description": "Chit Chats."
},
{
"value": "SMOOTH",
"description": "Smooth Couriers."
},
{
"value": "CLE_LOGISTICS",
"description": "CL E-Logistics Solutions Limited."
},
{
"value": "FIEGE",
"description": "Fiege Logistics."
},
{
"value": "MX_CARGO",
"description": "M&X cargo."
},
{
"value": "ZIINGFINALMILE",
"description": "Ziing Final Mile Inc."
},
{
"value": "DAYTON_FREIGHT",
"description": "Dayton Freight."
},
{
"value": "TCS",
"description": "TCS courier."
},
{
"value": "AEX",
"description": "AEX Group."
},
{
"value": "HERMES_DE",
"description": "Hermes Germany."
},
{
"value": "ROUTIFIC_WEBHOOK",
"description": "Routific."
},
{
"value": "GLOBAVEND",
"description": "Globavend."
},
{
"value": "CJ_LOGISTICS",
"description": "CJ Logistics International."
},
{
"value": "PALLET_NETWORK",
"description": "The Pallet Network."
},
{
"value": "RAF_PH",
"description": "RAF Philippines."
},
{
"value": "UK_XDP",
"description": "XDP Express."
},
{
"value": "PAPER_EXPRESS",
"description": "Paper Express."
},
{
"value": "LA_POSTE_SUIVI",
"description": "La Poste."
},
{
"value": "PAQUETEXPRESS",
"description": "Paquetexpress."
},
{
"value": "LIEFERY",
"description": "liefery."
},
{
"value": "STRECK_TRANSPORT",
"description": "Streck Transport."
},
{
"value": "PONY_EXPRESS",
"description": "Pony express."
},
{
"value": "ALWAYS_EXPRESS",
"description": "Always Express."
},
{
"value": "GBS_BROKER",
"description": "GBS-Broker."
},
{
"value": "CITYLINK_MY",
"description": "City-Link Express."
},
{
"value": "ALLJOY",
"description": "ALLJOY SUPPLY CHAIN."
},
{
"value": "YODEL",
"description": "yodel."
},
{
"value": "YODEL_DIR",
"description": "Yodel Direct."
},
{
"value": "STONE3PL",
"description": "STONE3PL."
},
{
"value": "PARCELPAL_WEBHOOK",
"description": "ParcelPal."
},
{
"value": "DHL_ECOMERCE_ASA",
"description": "DHL eCommerce Asia (API)."
},
{
"value": "SIMPLYPOST",
"description": "J&T Express Singapore."
},
{
"value": "KY_EXPRESS",
"description": "Kua Yue Express."
},
{
"value": "SHENZHEN",
"description": "shenzhen 1st International Logistics(Group)Co."
},
{
"value": "US_LASERSHIP",
"description": "LaserShip."
},
{
"value": "UC_EXPRE",
"description": "ucexpress."
},
{
"value": "DIDADI",
"description": "DIDADI Logistics tech."
},
{
"value": "CJ_KR",
"description": "CJ Korea Express."
},
{
"value": "DBSCHENKER_B2B",
"description": "DB Schenker B2B."
},
{
"value": "MXE",
"description": "MXE Express."
},
{
"value": "CAE_DELIVERS",
"description": "CAE Delivers."
},
{
"value": "PFCEXPRESS",
"description": "PFC Express."
},
{
"value": "WHISTL",
"description": "Whistl."
},
{
"value": "WEPOST",
"description": "WePost Sdn Bhd."
},
{
"value": "DHL_PARCEL_ES",
"description": "DHL parcel Spain(www.dhl.com)."
},
{
"value": "DDEXPRESS",
"description": "DD Express Courier."
},
{
"value": "ARAMEX_AU",
"description": "Aramex Australia (formerly Fastway AU)."
},
{
"value": "BNEED",
"description": "Bneed courier."
},
{
"value": "HK_TGX",
"description": "Kerry Express Hong Kong."
},
{
"value": "LATVIJAS_PASTS",
"description": "Latvijas Pasts."
},
{
"value": "VIAEUROPE",
"description": "ViaEurope."
},
{
"value": "CORREO_UY",
"description": "Correo Uruguayo."
},
{
"value": "CHRONOPOST_FR",
"description": "Chronopost france (www.chronopost.fr)."
},
{
"value": "J_NET",
"description": "J-Net."
},
{
"value": "_6LS",
"description": "6ls.com."
},
{
"value": "BLR_BELPOST",
"description": "Belpost."
},
{
"value": "BIRDSYSTEM",
"description": "BirdSystem."
},
{
"value": "DOBROPOST",
"description": "DobroPost."
},
{
"value": "WAHANA_ID",
"description": "Wahana express (www.wahana.com)."
},
{
"value": "WEASHIP",
"description": "Weaship."
},
{
"value": "SONICTL",
"description": "Sonic Transportation & Logistics."
},
{
"value": "KWT",
"description": "Shenzhen Jinghuada Logistics Co.."
},
{
"value": "AFLLOG_FTP",
"description": "AFL LOGISTICS."
},
{
"value": "SKYNET_WORLDWIDE",
"description": "SkyNet Worldwide Express."
},
{
"value": "NOVA_POSHTA",
"description": "Nova Poshta (novaposhta.ua)."
},
{
"value": "SEINO",
"description": "Seino."
},
{
"value": "SZENDEX",
"description": "SZENDEX."
},
{
"value": "BPOST_INT",
"description": "Bpost international."
},
{
"value": "DBSCHENKER_SV",
"description": "DB Schenker Sweden."
},
{
"value": "AO_DEUTSCHLAND",
"description": "AO Deutschland."
},
{
"value": "EU_FLEET_SOLUTIONS",
"description": "EU Fleet Solutions."
},
{
"value": "PCFCORP",
"description": "PCF Final Mile."
},
{
"value": "LINKBRIDGE",
"description": "Link Bridge(BeiJing)international logistics co.."
},
{
"value": "PRIMAMULTICIPTA",
"description": "PT Prima Multi Cipta."
},
{
"value": "COUREX",
"description": "Urbanfox."
},
{
"value": "ZAJIL_EXPRESS",
"description": "Zajil Express Company."
},
{
"value": "COLLECTCO",
"description": "CollectCo."
},
{
"value": "JTEXPRESS",
"description": "J&T EXPRESS MALAYSIA."
},
{
"value": "FEDEX_UK",
"description": "FedEx® UK."
},
{
"value": "USHIP",
"description": "uShip courier."
},
{
"value": "PIXSELL",
"description": "PIXSELL LOGISTICS."
},
{
"value": "SHIPTOR",
"description": "Shiptor."
},
{
"value": "CDEK",
"description": "CDEK courier."
},
{
"value": "VNM_VIETTELPOST",
"description": "ViettelPost."
},
{
"value": "CJ_CENTURY",
"description": "CJ Century."
},
{
"value": "GSO",
"description": "GSO(GLS-USA)."
},
{
"value": "VIWO",
"description": "VIWO IoT."
},
{
"value": "SKYBOX",
"description": "SKYBOX."
},
{
"value": "KERRYTJ",
"description": "Kerry TJ Logistics."
},
{
"value": "NTLOGISTICS_VN",
"description": "Nhat Tin Logistics."
},
{
"value": "SDH_SCM",
"description": "lightning monkey."
},
{
"value": "ZINC",
"description": "Zinc courier."
},
{
"value": "DPE_SOUTH_AFRC",
"description": "DPE South Africa."
},
{
"value": "CESKA_CZ",
"description": "Czech Post."
},
{
"value": "ACS_GR",
"description": "ACS Courier."
},
{
"value": "DEALERSEND",
"description": "DealerSend."
},
{
"value": "JOCOM",
"description": "Jocom."
},
{
"value": "CSE",
"description": "CSE courier."
},
{
"value": "TFORCE_FINALMILE",
"description": "TForce Final Mile."
},
{
"value": "SHIP_GATE",
"description": "ShipGate."
},
{
"value": "SHIPTER",
"description": "SHIPTER."
},
{
"value": "NATIONAL_SAMEDAY",
"description": "National Sameday."
},
{
"value": "YUNEXPRESS",
"description": "YunExpress."
},
{
"value": "CAINIAO",
"description": "AliExpress Standard Shipping."
},
{
"value": "DMS_MATRIX",
"description": "DMSMatrix."
},
{
"value": "DIRECTLOG",
"description": "Directlog (www.directlog.com.br)."
},
{
"value": "ASENDIA_US",
"description": "Asendia USA."
},
{
"value": "_3JMSLOGISTICS",
"description": "3JMS Logistics."
},
{
"value": "LICCARDI_EXPRESS",
"description": "LICCARDI EXPRESS COURIER."
},
{
"value": "SKY_POSTAL",
"description": "SkyPostal."
},
{
"value": "CNWANGTONG",
"description": "cnwangtong."
},
{
"value": "POSTNORD_LOGISTICS_DK",
"description": "ostnord denmark."
},
{
"value": "LOGISTIKA",
"description": "Logistika."
},
{
"value": "CELERITAS",
"description": "Celeritas Transporte."
},
{
"value": "PRESSIODE",
"description": "Pressio."
},
{
"value": "SHREE_MARUTI",
"description": "Shree Maruti Courier Services Pvt Ltd."
},
{
"value": "LOGISTICSWORLDWIDE_HK",
"description": "Logistic Worldwide Express (LWE Honkong)."
},
{
"value": "EFEX",
"description": "eFEx (E-Commerce Fulfillment & Express)."
},
{
"value": "LOTTE",
"description": "Lotte Global Logistics."
},
{
"value": "LONESTAR",
"description": "Lone Star Overnight."
},
{
"value": "APRISAEXPRESS",
"description": "Aprisa Express."
},
{
"value": "BEL_RS",
"description": "BEL North Russia."
},
{
"value": "OSM_WORLDWIDE",
"description": "OSM Worldwide."
},
{
"value": "WESTGATE_GL",
"description": "Westgate Global."
},
{
"value": "FASTRACK",
"description": "Fasttrack."
},
{
"value": "DTD_EXPR",
"description": "DTD Express."
},
{
"value": "ALFATREX",
"description": "AlfaTrex."
},
{
"value": "PROMEDDELIVERY",
"description": "ProMed Delivery."
},
{
"value": "THABIT_LOGISTICS",
"description": "Thabit Logistics."
},
{
"value": "HCT_LOGISTICS",
"description": "HCT LOGISTICS CO.LTD.."
},
{
"value": "CARRY_FLAP",
"description": "Carry-Flap Co.."
},
{
"value": "US_OLD_DOMINION",
"description": "Old Dominion Freight Line."
},
{
"value": "ANICAM_BOX",
"description": "ANICAM BOX EXPRESS."
},
{
"value": "WANBEXPRESS",
"description": "WanbExpress."
},
{
"value": "AN_POST",
"description": "An Post."
},
{
"value": "DPD_LOCAL",
"description": "DPD Local."
},
{
"value": "STALLIONEXPRESS",
"description": "Stallion Express."
},
{
"value": "RAIDEREX",
"description": "RaidereX."
},
{
"value": "SHOPFANS",
"description": "ShopfansRU LLC."
},
{
"value": "KYUNGDONG_PARCEL",
"description": "Kyungdong Parcel."
},
{
"value": "CHAMPION_LOGISTICS",
"description": "Champion Logistics."
},
{
"value": "PICKUPP_SGP",
"description": "PICK UPP (Singapore)."
},
{
"value": "MORNING_EXPRESS",
"description": "Morning Express."
},
{
"value": "NACEX",
"description": "NACEX."
},
{
"value": "THENILE_WEBHOOK",
"description": "SortHub courier."
},
{
"value": "HOLISOL",
"description": "Holisol."
},
{
"value": "LBCEXPRESS_FTP",
"description": "LBC EXPRESS INC.."
},
{
"value": "KURASI",
"description": "KURASI."
},
{
"value": "USF_REDDAWAY",
"description": "USF Reddaway."
},
{
"value": "APG",
"description": "APG eCommerce Solutions."
},
{
"value": "CN_BOXC",
"description": "BoxC courier."
},
{
"value": "ECOSCOOTING",
"description": "ECOSCOOTING."
},
{
"value": "MAINWAY",
"description": "Mainway."
},
{
"value": "PAPERFLY",
"description": "Paperfly Private Limited."
},
{
"value": "HOUNDEXPRESS",
"description": "Hound Express."
},
{
"value": "BOX_BERRY",
"description": "Boxberry courier."
},
{
"value": "EP_BOX",
"description": "EP-Box courier."
},
{
"value": "PLUS_LOG_UK",
"description": "Plus UK Logistics."
},
{
"value": "FULFILLA",
"description": "Fulfilla."
},
{
"value": "ASE",
"description": "ASE KARGO."
},
{
"value": "MAIL_PLUS",
"description": "MailPlus."
},
{
"value": "XPO_LOGISTICS",
"description": "XPO logistics."
},
{
"value": "WNDIRECT",
"description": "wnDirect."
},
{
"value": "CLOUDWISH_ASIA",
"description": "Cloudwish Asia."
},
{
"value": "ZELERIS",
"description": "Zeleris."
},
{
"value": "GIO_EXPRESS",
"description": "Gio Express."
},
{
"value": "OCS_WORLDWIDE",
"description": "OCS WORLDWIDE."
},
{
"value": "ARK_LOGISTICS",
"description": "ARK Logistics."
},
{
"value": "AQUILINE",
"description": "Aquiline."
},
{
"value": "PILOT_FREIGHT",
"description": "Pilot Freight Services."
},
{
"value": "QWINTRY",
"description": "Qwintry Logistics."
},
{
"value": "DANSKE_FRAGT",
"description": "Danske Fragtaend."
},
{
"value": "CARRIERS",
"description": "Carriers courier."
},
{
"value": "AIR_CANADA_GLOBAL",
"description": "Rivo (Air canada)."
},
{
"value": "PRESIDENT_TRANS",
"description": "PRESIDENT TRANSNET CORP."
},
{
"value": "STEPFORWARDFS",
"description": "STEP FORWARD FREIGHT SERVICE CO LTD."
},
{
"value": "SKYNET_UK",
"description": "Skynet UK."
},
{
"value": "PITTOHIO",
"description": "PITT OHIO."
},
{
"value": "CORREOS_EXPRESS",
"description": "Correos Express."
},
{
"value": "RL_US",
"description": "RL Carriers."
},
{
"value": "DESTINY",
"description": "Destiny Transportation."
},
{
"value": "UK_YODEL",
"description": "Yodel (www.yodel.co.uk)."
},
{
"value": "COMET_TECH",
"description": "CometTech."
},
{
"value": "DHL_PARCEL_RU",
"description": "DHL Parcel Russia."
},
{
"value": "TNT_REFR",
"description": "TNT Reference."
},
{
"value": "SHREE_ANJANI_COURIER",
"description": "Shree Anjani Courier."
},
{
"value": "MIKROPAKKET_BE",
"description": "Mikropakket Belgium."
},
{
"value": "ETS_EXPRESS",
"description": "RETS express."
},
{
"value": "COLIS_PRIVE",
"description": "Colis Privé."
},
{
"value": "CN_YUNDA",
"description": "Yunda Express."
},
{
"value": "AAA_COOPER",
"description": "AAA Cooper."
},
{
"value": "ROCKET_PARCEL",
"description": "Rocket Parcel International."
},
{
"value": "_360LION",
"description": "360 Lion Express."
},
{
"value": "PANDU",
"description": "PANDU."
},
{
"value": "PROFESSIONAL_COURIERS",
"description": "PROFESSIONAL COURIERS."
},
{
"value": "FLYTEXPRESS",
"description": "FLYTEXPRESS."
},
{
"value": "LOGISTICSWORLDWIDE_MY",
"description": "LOGISTICSWORLDWIDE MY."
},
{
"value": "CORREOS_DE_ESPANA",
"description": "CORREOS DE ESPANA."
},
{
"value": "IMX",
"description": "IMX."
},
{
"value": "FOUR_PX_EXPRESS",
"description": "FOUR PX EXPRESS."
},
{
"value": "XPRESSBEES",
"description": "XPRESSBEES."
},
{
"value": "PICKUPP_VNM",
"description": "pickupp_vnm."
},
{
"value": "STARTRACK_EXPRESS",
"description": "startrack_express."
},
{
"value": "FR_COLISSIMO",
"description": "fr_colissimo."
},
{
"value": "NACEX_SPAIN_REFERENCE",
"description": "nacex_spain_reference."
},
{
"value": "DHL_SUPPLY_CHAIN_AU",
"description": "dhl_supply_chain_au."
},
{
"value": "ESHIPPING",
"description": "Eshipping."
},
{
"value": "SHREETIRUPATI",
"description": "SHREE TIRUPATI COURIER SERVICES PVT. LTD.."
},
{
"value": "HX_EXPRESS",
"description": "HX Express."
},
{
"value": "INDOPAKET",
"description": "INDOPAKET."
},
{
"value": "CN_17POST",
"description": "17 Post Service."
},
{
"value": "K1_EXPRESS",
"description": "K1 Express."
},
{
"value": "CJ_GLS",
"description": "CJ GLS."
},
{
"value": "MYS_GDEX",
"description": "GDEX courier."
},
{
"value": "NATIONEX",
"description": "Nationex courier."
},
{
"value": "ANJUN",
"description": "Anjun couriers."
},
{
"value": "FARGOOD",
"description": "FarGood."
},
{
"value": "SMG_EXPRESS",
"description": "SMG Direct."
},
{
"value": "RZYEXPRESS",
"description": "RZY Express."
},
{
"value": "SEFL",
"description": "Southeastern Freight Lines."
},
{
"value": "TNT_CLICK_IT",
"description": "TNT-Click Italy."
},
{
"value": "HDB",
"description": "Haidaibao."
},
{
"value": "HIPSHIPPER",
"description": "Hipshipper."
},
{
"value": "RPXLOGISTICS",
"description": "RPX Logistics."
},
{
"value": "KUEHNE",
"description": "Kuehne + Nagel."
},
{
"value": "IT_NEXIVE",
"description": "Nexive (TNT Post Italy)."
},
{
"value": "PTS",
"description": "PTS courier."
},
{
"value": "SWISS_POST_FTP",
"description": "Swiss Post FTP."
},
{
"value": "FASTRK_SERV",
"description": "Fastrak Services."
},
{
"value": "_4_72",
"description": "4-72 Entregando."
},
{
"value": "US_YRC",
"description": "YRC courier."
},
{
"value": "POSTNL_INTL_3S",
"description": "PostNL International 3S."
},
{
"value": "ELIAN_POST",
"description": "Yilian (Elian) Supply Chain."
},
{
"value": "CUBYN",
"description": "Cubyn."
},
{
"value": "SAU_SAUDI_POST",
"description": "Saudi Post."
},
{
"value": "ABXEXPRESS_MY",
"description": "ABX Express."
},
{
"value": "HUAHAN_EXPRESS",
"description": "HUAHANG EXPRESS."
},
{
"value": "ZES_EXPRESS",
"description": "Eshun international Logistic."
},
{
"value": "ZEPTO_EXPRESS",
"description": "ZeptoExpress."
},
{
"value": "SKYNET_ZA",
"description": "Skynet World Wide Express South Africa."
},
{
"value": "ZEEK_2_DOOR",
"description": "Zeek2Door."
},
{
"value": "BLINKLASTMILE",
"description": "Blink."
},
{
"value": "POSTA_UKR",
"description": "UkrPoshta."
},
{
"value": "CHROBINSON",
"description": "C.H. Robinson Worldwide."
},
{
"value": "CN_POST56",
"description": "Post56."
},
{
"value": "COURANT_PLUS",
"description": "Courant Plus."
},
{
"value": "SCUDEX_EXPRESS",
"description": "Scudex Express."
},
{
"value": "SHIPENTEGRA",
"description": "ShipEntegra."
},
{
"value": "B_TWO_C_EUROPE",
"description": "B2C courier Europe."
},
{
"value": "COPE",
"description": "Cope Sensitive Freight."
},
{
"value": "IND_GATI",
"description": "Gati-KWE."
},
{
"value": "CN_WISHPOST",
"description": "WishPost."
},
{
"value": "NACEX_ES",
"description": "NACEX Spain."
},
{
"value": "TAQBIN_HK",
"description": "TAQBIN Hong Kong."
},
{
"value": "GLOBALTRANZ",
"description": "GlobalTranz."
},
{
"value": "HKD",
"description": "Qingdao HKD International Logistics."
},
{
"value": "BJSHOMEDELIVERY",
"description": "BJS Distribution courier."
},
{
"value": "OMNIVA",
"description": "Omniva."
},
{
"value": "SUTTON",
"description": "Sutton Transport."
},
{
"value": "PANTHER_REFERENCE",
"description": "Panther Reference."
},
{
"value": "SFCSERVICE",
"description": "SFC Service."
},
{
"value": "LTL",
"description": "LTL COURIER."
},
{
"value": "PARKNPARCEL",
"description": "Park N Parcel."
},
{
"value": "SPRING_GDS",
"description": "Spring GDS."
},
{
"value": "ECEXPRESS",
"description": "ECexpress."
},
{
"value": "INTERPARCEL_AU",
"description": "Interparcel Australia."
},
{
"value": "AGILITY",
"description": "Agility."
},
{
"value": "XL_EXPRESS",
"description": "XL Express."
},
{
"value": "ADERONLINE",
"description": "Ader couriers."
},
{
"value": "DIRECTCOURIERS",
"description": "Direct Couriers."
},
{
"value": "PLANZER",
"description": "Planzer Group."
},
{
"value": "SENDING",
"description": "Sending Transporte Urgente y Comunicacion."
},
{
"value": "NINJAVAN_WB",
"description": "Ninjavan Webhook."
},
{
"value": "NATIONWIDE_MY",
"description": "Nationwide Express Courier Services Bhd (www.nationwide.com.my)."
},
{
"value": "SENDIT",
"description": "Sendit."
},
{
"value": "GB_ARROW",
"description": "Arrow XL."
},
{
"value": "IND_GOJAVAS",
"description": "GoJavas."
},
{
"value": "KPOST",
"description": "Korea Post."
},
{
"value": "DHL_FREIGHT",
"description": "DHL Freight."
},
{
"value": "BLUECARE",
"description": "Bluecare Express Ltd."
},
{
"value": "JINDOUYUN",
"description": "jindouyun courier."
},
{
"value": "TRACKON",
"description": "Trackon Couriers Pvt. Ltd."
},
{
"value": "GB_TUFFNELLS",
"description": "Tuffnells Parcels Express."
},
{
"value": "TRUMPCARD",
"description": "TRUMPCARD LLC."
},
{
"value": "ETOTAL",
"description": "eTotal Solution Limited."
},
{
"value": "SFPLUS_WEBHOOK",
"description": "Zeek courier."
},
{
"value": "SEKOLOGISTICS",
"description": "SEKO Logistics."
},
{
"value": "HERMES_2MANN_HANDLING",
"description": "Hermes Einrichtungs Service GmbH & Co. KG."
},
{
"value": "DPD_LOCAL_REF",
"description": "DPD Local reference."
},
{
"value": "UDS",
"description": "United Delivery Service."
},
{
"value": "ZA_SPECIALISED_FREIGHT",
"description": "Specialised Freight."
},
{
"value": "THA_KERRY",
"description": "Kerry Express Thailand."
},
{
"value": "PRT_INT_SEUR",
"description": "SEUR International."
},
{
"value": "BRA_CORREIOS",
"description": "Correios Brazil."
},
{
"value": "NZ_NZ_POST",
"description": "New Zealand Post."
},
{
"value": "CN_EQUICK",
"description": "Equick China."
},
{
"value": "MYS_EMS",
"description": "Malaysia Post EMS / Pos Laju."
},
{
"value": "GB_NORSK",
"description": "Norsk Global."
},
{
"value": "ESP_MRW",
"description": "MRW spain."
},
{
"value": "ESP_PACKLINK",
"description": "Packlink."
},
{
"value": "KANGAROO_MY",
"description": "Kangaroo Worldwide Express."
},
{
"value": "RPX",
"description": "RPX Online."
},
{
"value": "XDP_UK_REFERENCE",
"description": "XDP Express Reference."
},
{
"value": "NINJAVAN_MY",
"description": "ninja van (www.ninjavan.co)."
},
{
"value": "ADICIONAL",
"description": "Adicional Logistics."
},
{
"value": "ROADBULL",
"description": "Red Carpet Logistics."
},
{
"value": "YAKIT",
"description": "Yakit courier."
},
{
"value": "MAILAMERICAS",
"description": "MailAmericas."
},
{
"value": "MIKROPAKKET",
"description": "Mikropakket."
},
{
"value": "DYNALOGIC",
"description": "Dynamic Logistics."
},
{
"value": "DHL_ES",
"description": "DHL Spain(www.dhl.com)."
},
{
"value": "DHL_PARCEL_NL",
"description": "DHL Parcel NL."
},
{
"value": "DHL_GLOBAL_MAIL_ASIA",
"description": "DHL Global Mail Asia (www.dhl.com)."
},
{
"value": "DAWN_WING",
"description": "Dawn Wing."
},
{
"value": "GENIKI_GR",
"description": "Geniki Taxydromiki."
},
{
"value": "HERMESWORLD_UK",
"description": "hermesworld_uk."
},
{
"value": "ALPHAFAST",
"description": "Alphafast (www.alphafast.com)."
},
{
"value": "BUYLOGIC",
"description": "buylogic."
},
{
"value": "EKART",
"description": "Ekart logistics (ekartlogistics.com)."
},
{
"value": "MEX_SENDA",
"description": "mexico senda express."
},
{
"value": "SFC_LOGISTICS",
"description": "SFC."
},
{
"value": "POST_SERBIA",
"description": "Posta Serbia."
},
{
"value": "IND_DELHIVERY",
"description": "Delhivery India."
},
{
"value": "DE_DPD_DELISTRACK",
"description": "DPD Germany."
},
{
"value": "RPD2MAN",
"description": "RPD2man Deliveries."
},
{
"value": "CN_SF_EXPRESS",
"description": "SF Express (www.sf-express.com)."
},
{
"value": "YANWEN",
"description": "Yanwen Logistics."
},
{
"value": "MYS_SKYNET",
"description": "Skynet Malaysia."
},
{
"value": "CORREOS_DE_MEXICO",
"description": "correos mexico."
},
{
"value": "CBL_LOGISTICA",
"description": "CBL Logistica."
},
{
"value": "MEX_ESTAFETA",
"description": "Estafeta (www.estafeta.com)."
},
{
"value": "AU_AUSTRIAN_POST",
"description": "Austrian Post (Registered)."
},
{
"value": "RINCOS",
"description": "Rincos."
},
{
"value": "NLD_DHL",
"description": "DHL Netherland."
},
{
"value": "RUSSIAN_POST",
"description": "Russian post."
},
{
"value": "COURIERS_PLEASE",
"description": "CouriersPlease (couriersplease.com.au)."
},
{
"value": "POSTNORD_LOGISTICS",
"description": "PostNord Logistics."
},
{
"value": "FEDEX",
"description": "Fedex."
},
{
"value": "DPE_EXPRESS",
"description": "DPE Express."
},
{
"value": "DPD",
"description": "DPD."
},
{
"value": "ADSONE",
"description": "ADSone."
},
{
"value": "IDN_JNE",
"description": "JNE Express (Jalur Nugraha Ekakurir)."
},
{
"value": "THECOURIERGUY",
"description": "The Courier Guy."
},
{
"value": "CNEXPS",
"description": "CNE Express."
},
{
"value": "PRT_CHRONOPOST",
"description": "Chronopost Portugal."
},
{
"value": "LANDMARK_GLOBAL",
"description": "Landmark Global."
},
{
"value": "IT_DHL_ECOMMERCE",
"description": "DHL International."
},
{
"value": "ESP_NACEX",
"description": "NACEX Spain."
},
{
"value": "PRT_CTT",
"description": "CTT Portugal."
},
{
"value": "BE_KIALA",
"description": "Kiala."
},
{
"value": "ASENDIA_UK",
"description": "Asendia UK."
},
{
"value": "GLOBAL_TNT",
"description": "TNT global."
},
{
"value": "POSTUR_IS",
"description": "Iceland Post."
},
{
"value": "EPARCEL_KR",
"description": "eParcel Korea."
},
{
"value": "INPOST_PACZKOMATY",
"description": "InPost Paczkomaty."
},
{
"value": "IT_POSTE_ITALIA",
"description": "Poste italiane (www.poste.it)."
},
{
"value": "BE_BPOST",
"description": "Bpost (www.bpost.be)."
},
{
"value": "PL_POCZTA_POLSKA",
"description": "Poczta Polska (www.poczta-polska.pl)."
},
{
"value": "MYS_MYS_POST",
"description": "Malaysia Post."
},
{
"value": "SG_SG_POST",
"description": "Singapore Post."
},
{
"value": "THA_THAILAND_POST",
"description": "Thailand Post (www.thailandpost.co.th)."
},
{
"value": "LEXSHIP",
"description": "LexShip."
},
{
"value": "FASTWAY_NZ",
"description": "Fastway New Zealand."
},
{
"value": "DHL_AU",
"description": "DHL Supply Chain Australia."
},
{
"value": "COSTMETICSNOW",
"description": "Cosmetics Now."
},
{
"value": "PFLOGISTICS",
"description": "PFL."
},
{
"value": "LOOMIS_EXPRESS",
"description": "Loomis Express."
},
{
"value": "GLS_ITALY",
"description": "GLS Italy."
},
{
"value": "LINE",
"description": "Line Clear Express & Logistics Sdn Bhd."
},
{
"value": "GEL_EXPRESS",
"description": "Gel Express Logistik."
},
{
"value": "HUODULL",
"description": "Huodull."
},
{
"value": "NINJAVAN_SG",
"description": "Ninja van Singapore."
},
{
"value": "JANIO",
"description": "Janio Asia."
},
{
"value": "AO_COURIER",
"description": "AO Logistics."
},
{
"value": "BRT_IT_SENDER_REF",
"description": "BRT Bartolini(Sender Reference)."
},
{
"value": "SAILPOST",
"description": "SAILPOST."
},
{
"value": "LALAMOVE",
"description": "Lalamove."
},
{
"value": "NEWZEALAND_COURIERS",
"description": "NEW ZEALAND COURIERS."
},
{
"value": "ETOMARS",
"description": "Etomars."
},
{
"value": "VIRTRANSPORT",
"description": "VIR Transport."
},
{
"value": "WIZMO",
"description": "Wizmo."
},
{
"value": "PALLETWAYS",
"description": "Palletways."
},
{
"value": "I_DIKA",
"description": "i-dika."
},
{
"value": "CFL_LOGISTICS",
"description": "CFL Logistics."
},
{
"value": "GEMWORLDWIDE",
"description": "GEM Worldwide."
},
{
"value": "GLOBAL_EXPRESS",
"description": "Tai Wan Global Business."
},
{
"value": "LOGISTYX_TRANSGROUP",
"description": "Transgroup courier."
},
{
"value": "WESTBANK_COURIER",
"description": "West Bank Courier."
},
{
"value": "ARCO_SPEDIZIONI",
"description": "Arco Spedizioni SP."
},
{
"value": "YDH_EXPRESS",
"description": "YDH express."
},
{
"value": "PARCELINKLOGISTICS",
"description": "Parcelink Logistics."
},
{
"value": "CNDEXPRESS",
"description": "CND Express."
},
{
"value": "NOX_NIGHT_TIME_EXPRESS",
"description": "NOX NightTimeExpress."
},
{
"value": "AERONET",
"description": "Aeronet couriers."
},
{
"value": "LTIANEXP",
"description": "LTIAN EXP."
},
{
"value": "INTEGRA2_FTP",
"description": "Integra2."
},
{
"value": "PARCELONE",
"description": "PARCEL ONE."
},
{
"value": "NOX_NACHTEXPRESS",
"description": "Innight Express Germany GmbH (nox NachtExpress)."
},
{
"value": "CN_CHINA_POST_EMS",
"description": "China Post."
},
{
"value": "CHUKOU1",
"description": "Chukou1."
},
{
"value": "GLS_SLOV",
"description": "GLS General Logistics Systems Slovakia s.r.o.."
},
{
"value": "ORANGE_DS",
"description": "OrangeDS (Orange Distribution Solutions Inc)."
},
{
"value": "JOOM_LOGIS",
"description": "Joom Logistics."
},
{
"value": "AUS_STARTRACK",
"description": "StarTrack (startrack.com.au)."
},
{
"value": "DHL",
"description": "dhl Global."
},
{
"value": "GB_APC",
"description": "APC postal logistics germany."
},
{
"value": "BONDSCOURIERS",
"description": "Bonds Courier Service (bondscouriers.com.au)."
},
{
"value": "JPN_JAPAN_POST",
"description": "Japan Post."
},
{
"value": "USPS",
"description": "United States Postal Service."
},
{
"value": "WINIT",
"description": "WinIt."
},
{
"value": "ARG_OCA",
"description": "OCA Argentina."
},
{
"value": "TW_TAIWAN_POST",
"description": "Taiwan Post."
},
{
"value": "DMM_NETWORK",
"description": "DMM Network."
},
{
"value": "TNT",
"description": "TNT Express."
},
{
"value": "BH_POSTA",
"description": "BH Posta (www.posta.ba)."
},
{
"value": "SWE_POSTNORD",
"description": "Postnord sweden."
},
{
"value": "CA_CANADA_POST",
"description": "Canada Post."
},
{
"value": "WISELOADS",
"description": "Wiseloads."
},
{
"value": "ASENDIA_HK",
"description": "Asendia HonKong."
},
{
"value": "NLD_GLS",
"description": "GLS Netherland."
},
{
"value": "MEX_REDPACK",
"description": "Redpack."
},
{
"value": "JET_SHIP",
"description": "Jet-Ship Worldwide."
},
{
"value": "DE_DHL_EXPRESS",
"description": "DHL Express."
},
{
"value": "NINJAVAN_THAI",
"description": "Ninja van Thai."
},
{
"value": "RABEN_GROUP",
"description": "Raben Group."
},
{
"value": "ESP_ASM",
"description": "ASM(GLS Spain)."
},
{
"value": "HRV_HRVATSKA",
"description": "Hrvatska posta."
},
{
"value": "GLOBAL_ESTES",
"description": "Estes Express Lines."
},
{
"value": "LTU_LIETUVOS",
"description": "Lietuvos pastas."
},
{
"value": "BEL_DHL",
"description": "DHL Benelux."
},
{
"value": "AU_AU_POST",
"description": "Australia Post."
},
{
"value": "SPEEDEXCOURIER",
"description": "SPEEDEX couriers."
},
{
"value": "FR_COLIS",
"description": "Colissimo."
},
{
"value": "ARAMEX",
"description": "Aramex."
},
{
"value": "DPEX",
"description": "DPEX (www.dpex.com)."
},
{
"value": "MYS_AIRPAK",
"description": "Airpak Express."
},
{
"value": "CUCKOOEXPRESS",
"description": "Cuckoo Express."
},
{
"value": "DPD_POLAND",
"description": "DPD Poland."
},
{
"value": "NLD_POSTNL",
"description": "PostNL International."
},
{
"value": "NIM_EXPRESS",
"description": "Nim Express."
},
{
"value": "QUANTIUM",
"description": "Quantium."
},
{
"value": "SENDLE",
"description": "Sendle."
},
{
"value": "ESP_REDUR",
"description": "Redur Spain."
},
{
"value": "MATKAHUOLTO",
"description": "Matkahuolto."
},
{
"value": "CPACKET",
"description": "Cpacket couriers."
},
{
"value": "POSTI",
"description": "Posti courier."
},
{
"value": "HUNTER_EXPRESS",
"description": "Hunter Express."
},
{
"value": "CHOIR_EXP",
"description": "Choir Express Indonesia."
},
{
"value": "LEGION_EXPRESS",
"description": "Legion Express."
},
{
"value": "AUSTRIAN_POST_EXPRESS",
"description": "austrian post."
},
{
"value": "GRUPO",
"description": "Grupo ampm."
},
{
"value": "POSTA_RO",
"description": "Post Roman (www.posta-romana.ro)."
},
{
"value": "INTERPARCEL_UK",
"description": "Interparcel UK."
},
{
"value": "GLOBAL_ABF",
"description": "ABF Freight."
},
{
"value": "POSTEN_NORGE",
"description": "Posten Norge (www.posten.no)."
},
{
"value": "XPERT_DELIVERY",
"description": "Xpert Delivery."
},
{
"value": "DHL_REFR",
"description": "DHl (Reference number)."
},
{
"value": "DHL_HK",
"description": "DHL HonKong."
},
{
"value": "SKYNET_UAE",
"description": "SKYNET UAE."
},
{
"value": "GOJEK",
"description": "Gojek."
},
{
"value": "YODEL_INTNL",
"description": "Yodel International."
},
{
"value": "JANCO",
"description": "Janco Ecommerce."
},
{
"value": "YTO",
"description": "YTO Express."
},
{
"value": "WISE_EXPRESS",
"description": "Wise Express."
},
{
"value": "JTEXPRESS_VN",
"description": "J&T Express Vietnam."
},
{
"value": "FEDEX_INTL_MLSERV",
"description": "FedEx International MailService."
},
{
"value": "VAMOX",
"description": "VAMOX."
},
{
"value": "AMS_GRP",
"description": "AMS Group."
},
{
"value": "DHL_JP",
"description": "DHL Japan."
},
{
"value": "HRPARCEL",
"description": "HR Parcel."
},
{
"value": "GESWL",
"description": "GESWL Express."
},
{
"value": "BLUESTAR",
"description": "Blue Star."
},
{
"value": "CDEK_TR",
"description": "CDEK TR."
},
{
"value": "DESCARTES",
"description": "Innovel courier."
},
{
"value": "DELTEC_UK",
"description": "Deltec Courier."
},
{
"value": "DTDC_EXPRESS",
"description": "DTDC express."
},
{
"value": "TOURLINE",
"description": "tourline."
},
{
"value": "BH_WORLDWIDE",
"description": "B&H Worldwide."
},
{
"value": "OCS",
"description": "OCS ANA Group."
},
{
"value": "YINGNUO_LOGISTICS",
"description": "yingnuo logistics."
},
{
"value": "UPS",
"description": "United Parcel Service."
},
{
"value": "TOLL",
"description": "Toll IPEC."
},
{
"value": "PRT_SEUR",
"description": "SEUR portugal."
},
{
"value": "DTDC_AU",
"description": "DTDC Australia."
},
{
"value": "THA_DYNAMIC_LOGISTICS",
"description": "Dynamic Logistics."
},
{
"value": "UBI_LOGISTICS",
"description": "UBI Smart Parcel."
},
{
"value": "FEDEX_CROSSBORDER",
"description": "FedEx Cross Border."
},
{
"value": "A1POST",
"description": "A1Post."
},
{
"value": "TAZMANIAN_FREIGHT",
"description": "Tazmanian Freight Systems."
},
{
"value": "CJ_INT_MY",
"description": "CJ International malaysia."
},
{
"value": "SAIA_FREIGHT",
"description": "Saia LTL Freight."
},
{
"value": "SG_QXPRESS",
"description": "Qxpress."
},
{
"value": "NHANS_SOLUTIONS",
"description": "Nhans Solutions."
},
{
"value": "DPD_FR",
"description": "DPD France."
},
{
"value": "COORDINADORA",
"description": "Coordinadora."
},
{
"value": "ANDREANI",
"description": "Grupo logistico Andreani."
},
{
"value": "DOORA",
"description": "Doora Logistics."
},
{
"value": "INTERPARCEL_NZ",
"description": "Interparcel New Zealand."
},
{
"value": "PHL_JAMEXPRESS",
"description": "Jam Express Philippines."
},
{
"value": "BEL_BELGIUM_POST",
"description": "bel_belgium_post."
},
{
"value": "US_APC",
"description": "us_apc."
},
{
"value": "IDN_POS",
"description": "idn_pos."
},
{
"value": "FR_MONDIAL",
"description": "fr_mondial."
},
{
"value": "DE_DHL",
"description": "DE DHL."
},
{
"value": "HK_RPX",
"description": "hk_rpx."
},
{
"value": "DHL_PIECEID",
"description": "dhl_pieceid."
},
{
"value": "VNPOST_EMS",
"description": "vnpost_ems."
},
{
"value": "RRDONNELLEY",
"description": "rrdonnelley."
},
{
"value": "DPD_DE",
"description": "dpd_de."
},
{
"value": "DELCART_IN",
"description": "delcart_in."
},
{
"value": "IMEXGLOBALSOLUTIONS",
"description": "imexglobalsolutions."
},
{
"value": "ACOMMERCE",
"description": "ACOMMERCE."
},
{
"value": "EURODIS",
"description": "eurodis."
},
{
"value": "CANPAR",
"description": "CANPAR."
},
{
"value": "GLS",
"description": "GLS."
},
{
"value": "IND_ECOM",
"description": "Ecom Express."
},
{
"value": "ESP_ENVIALIA",
"description": "Envialia."
},
{
"value": "DHL_UK",
"description": "dhl UK."
},
{
"value": "SMSA_EXPRESS",
"description": "SMSA Express."
},
{
"value": "TNT_FR",
"description": "TNT France."
},
{
"value": "DEX_I",
"description": "DEX-I courier."
},
{
"value": "BUDBEE_WEBHOOK",
"description": "Budbee courier."
},
{
"value": "COPA_COURIER",
"description": "Copa Airlines Courier."
},
{
"value": "VNM_VIETNAM_POST",
"description": "Vietnam Post."
},
{
"value": "DPD_HK",
"description": "DPD HongKong."
},
{
"value": "TOLL_NZ",
"description": "Toll New Zealand."
},
{
"value": "ECHO",
"description": "Echo courier."
},
{
"value": "FEDEX_FR",
"description": "FedEx® Freight."
},
{
"value": "BORDEREXPRESS",
"description": "Border Express."
},
{
"value": "MAILPLUS_JPN",
"description": "MailPlus (Japan)."
},
{
"value": "TNT_UK_REFR",
"description": "TNT UK Reference."
},
{
"value": "KEC",
"description": "KEC courier."
},
{
"value": "DPD_RO",
"description": "DPD Romania."
},
{
"value": "TNT_JP",
"description": "TNT_JP."
},
{
"value": "TH_CJ",
"description": "TH_CJ."
},
{
"value": "EC_CN",
"description": "EC_CN."
},
{
"value": "FASTWAY_UK",
"description": "FASTWAY_UK."
},
{
"value": "FASTWAY_US",
"description": "FASTWAY_US."
},
{
"value": "GLS_DE",
"description": "GLS_DE."
},
{
"value": "GLS_ES",
"description": "GLS_ES."
},
{
"value": "GLS_FR",
"description": "GLS_FR."
},
{
"value": "MONDIAL_BE",
"description": "MONDIAL_BE."
},
{
"value": "SGT_IT",
"description": "SGT_IT."
},
{
"value": "TNT_CN",
"description": "TNT_CN."
},
{
"value": "TNT_DE",
"description": "TNT_DE."
},
{
"value": "TNT_ES",
"description": "TNT_ES."
},
{
"value": "TNT_PL",
"description": "TNT_PL."
},
{
"value": "PARCELFORCE",
"description": "PARCELFORCE."
},
{
"value": "SWISS_POST",
"description": "SWISS POST."
},
{
"value": "TOLL_IPEC",
"description": "TOLL IPEC."
},
{
"value": "AIR_21",
"description": "AIR 21."
},
{
"value": "AIRSPEED",
"description": "AIRSPEED."
},
{
"value": "BERT",
"description": "BERT."
},
{
"value": "BLUEDART",
"description": "BLUEDART."
},
{
"value": "COLLECTPLUS",
"description": "COLLECTPLUS."
},
{
"value": "COURIERPLUS",
"description": "COURIERPLUS."
},
{
"value": "COURIER_POST",
"description": "COURIER POST."
},
{
"value": "DHL_GLOBAL_MAIL",
"description": "dhl_global_mail."
},
{
"value": "DPD_UK",
"description": "dpd_uk."
},
{
"value": "DELTEC_DE",
"description": "DELTEC DE."
},
{
"value": "DEUTSCHE_DE",
"description": "deutsche_de."
},
{
"value": "DOTZOT",
"description": "DOTZOT."
},
{
"value": "ELTA_GR",
"description": "elta_gr."
},
{
"value": "EMS_CN",
"description": "ems_cn."
},
{
"value": "ECARGO",
"description": "ECARGO."
},
{
"value": "ENSENDA",
"description": "ENSENDA."
},
{
"value": "FERCAM_IT",
"description": "fercam_it."
},
{
"value": "FASTWAY_ZA",
"description": "fastway_za."
},
{
"value": "FASTWAY_AU",
"description": "fastway_au."
},
{
"value": "FIRST_LOGISITCS",
"description": "first_logisitcs."
},
{
"value": "GEODIS",
"description": "GEODIS."
},
{
"value": "GLOBEGISTICS",
"description": "GLOBEGISTICS."
},
{
"value": "GREYHOUND",
"description": "GREYHOUND."
},
{
"value": "JETSHIP_MY",
"description": "jetship_my."
},
{
"value": "LION_PARCEL",
"description": "LION PARCEL."
},
{
"value": "AEROFLASH",
"description": "AEROFLASH."
},
{
"value": "ONTRAC",
"description": "ONTRAC."
},
{
"value": "SAGAWA",
"description": "SAGAWA."
},
{
"value": "SIODEMKA",
"description": "SIODEMKA."
},
{
"value": "STARTRACK",
"description": "startrack."
},
{
"value": "TNT_AU",
"description": "tnt_au."
},
{
"value": "TNT_IT",
"description": "tnt_it."
},
{
"value": "TRANSMISSION",
"description": "TRANSMISSION."
},
{
"value": "YAMATO",
"description": "YAMATO."
},
{
"value": "DHL_IT",
"description": "dhl_it."
},
{
"value": "DHL_AT",
"description": "dhl_at."
},
{
"value": "LOGISTICSWORLDWIDE_KR",
"description": "LOGISTICSWORLDWIDE KR."
},
{
"value": "GLS_SPAIN",
"description": "gls_spain."
},
{
"value": "AMAZON_UK_API",
"description": "amazon_uk_api."
},
{
"value": "DPD_FR_REFERENCE",
"description": "dpd_fr_reference."
},
{
"value": "DHLPARCEL_UK",
"description": "dhlparcel_uk."
},
{
"value": "MEGASAVE",
"description": "megasave."
},
{
"value": "QUALITYPOST",
"description": "qualitypost."
},
{
"value": "IDS_LOGISTICS",
"description": "ids_logistics."
},
{
"value": "JOYINGBOX",
"description": "joyingbox."
},
{
"value": "PANTHER_ORDER_NUMBER",
"description": "panther_order_number."
},
{
"value": "WATKINS_SHEPARD",
"description": "watkins_shepard."
},
{
"value": "FASTTRACK",
"description": "fasttrack."
},
{
"value": "UP_EXPRESS",
"description": "up_express."
},
{
"value": "ELOGISTICA",
"description": "elogistica."
},
{
"value": "ECOURIER",
"description": "ecourier."
},
{
"value": "CJ_PHILIPPINES",
"description": "cj_philippines."
},
{
"value": "SPEEDEX",
"description": "speedex."
},
{
"value": "ORANGECONNEX",
"description": "orangeconnex."
},
{
"value": "TECOR",
"description": "tecor."
},
{
"value": "SAEE",
"description": "saee."
},
{
"value": "GLS_ITALY_FTP",
"description": "gls_italy_ftp."
},
{
"value": "DELIVERE",
"description": "delivere."
},
{
"value": "YYCOM",
"description": "yycom."
},
{
"value": "ADICIONAL_PT",
"description": "Adicional Logistics."
},
{
"value": "DKSH",
"description": "DKSH."
},
{
"value": "NIPPON_EXPRESS_FTP",
"description": "Nippon Express."
},
{
"value": "GOLS",
"description": "GO Logistics & Storage."
},
{
"value": "FUJEXP",
"description": "FUJIE EXPRESS."
},
{
"value": "QTRACK",
"description": "QTrack."
},
{
"value": "OMLOGISTICS_API",
"description": "OM LOGISTICS LTD."
},
{
"value": "GDPHARM",
"description": "GDPharm Logistics."
},
{
"value": "MISUMI_CN",
"description": "MISUMI Group Inc.."
},
{
"value": "AIR_CANADA",
"description": "Rivo."
},
{
"value": "CITY56_WEBHOOK",
"description": "City Express."
},
{
"value": "SAGAWA_API",
"description": "Sagawa."
},
{
"value": "KEDAEX",
"description": "KedaEX."
},
{
"value": "PGEON_API",
"description": "Pgeon."
},
{
"value": "WEWORLDEXPRESS",
"description": "We World Express."
},
{
"value": "JT_LOGISTICS",
"description": "J&T International logistics."
},
{
"value": "TRUSK",
"description": "Trusk France."
},
{
"value": "VIAXPRESS",
"description": "ViaXpress."
},
{
"value": "DHL_SUPPLYCHAIN_ID",
"description": "DHL Supply Chain Indonesia."
},
{
"value": "ZUELLIGPHARMA_SFTP",
"description": "Zuellig Pharma Korea."
},
{
"value": "MEEST",
"description": "Meest."
},
{
"value": "TOLL_PRIORITY",
"description": "Toll Priority."
},
{
"value": "MOTHERSHIP_API",
"description": "Mothership."
},
{
"value": "CAPITAL",
"description": "Capital Transport."
},
{
"value": "EUROPAKET_API",
"description": "Europacket+."
},
{
"value": "HFD",
"description": "HFD."
},
{
"value": "TOURLINE_REFERENCE",
"description": "Tourline Express."
},
{
"value": "GIO_ECOURIER",
"description": "GIO Express Inc."
},
{
"value": "CN_LOGISTICS",
"description": "CN Logistics."
},
{
"value": "PANDION",
"description": "Pandion."
},
{
"value": "BPOST_API",
"description": "Bpost API."
},
{
"value": "PASSPORTSHIPPING",
"description": "Passport Shipping."
},
{
"value": "PAKAJO",
"description": "Pakajo World."
},
{
"value": "DACHSER",
"description": "DACHSER."
},
{
"value": "YUSEN_SFTP",
"description": "Yusen Logistics."
},
{
"value": "SHYPLITE",
"description": "Shypmax."
},
{
"value": "XYY",
"description": "Xingyunyi Logistics."
},
{
"value": "MWD",
"description": "Metropolitan Warehouse & Delivery."
},
{
"value": "FAXECARGO",
"description": "Faxe Cargo."
},
{
"value": "MAZET",
"description": "Groupe Mazet."
},
{
"value": "FIRST_LOGISTICS_API",
"description": "First Logistics."
},
{
"value": "SPRINT_PACK",
"description": "SPRINT PACK."
},
{
"value": "HERMES_DE_FTP",
"description": "Hermes Germany."
},
{
"value": "CONCISE",
"description": "Concise."
},
{
"value": "KERRY_EXPRESS_TW_API",
"description": "Kerry Express TaiWan."
},
{
"value": "EWE",
"description": "EWE Global Express."
},
{
"value": "FASTDESPATCH",
"description": "Fast Despatch Logistics Limited."
},
{
"value": "ABCUSTOM_SFTP",
"description": "AB Custom Group."
},
{
"value": "CHAZKI",
"description": "Chazki."
},
{
"value": "SHIPPIE",
"description": "Shippie."
},
{
"value": "GEODIS_API",
"description": "GEODIS - Distribution & Express."
},
{
"value": "NAQEL_EXPRESS",
"description": "Naqel Express."
},
{
"value": "PAPA_WEBHOOK",
"description": "Papa."
},
{
"value": "FORWARDAIR",
"description": "Forward Air."
},
{
"value": "DIALOGO_LOGISTICA_API",
"description": "Dialogo Logistica."
},
{
"value": "LALAMOVE_API",
"description": "Lalamove."
},
{
"value": "TOMYDOOR",
"description": "Tomydoor."
},
{
"value": "KRONOS_WEBHOOK",
"description": "Kronos Express."
},
{
"value": "JTCARGO",
"description": "J&T CARGO."
},
{
"value": "T_CAT",
"description": "T-cat."
},
{
"value": "CONCISE_WEBHOOK",
"description": "Concise."
},
{
"value": "TELEPORT_WEBHOOK",
"description": "Teleport."
},
{
"value": "CUSTOMCO_API",
"description": "The Custom Companies."
},
{
"value": "SPX_TH",
"description": "Shopee Xpress."
},
{
"value": "BOLLORE_LOGISTICS",
"description": "Bollore Logistics."
},
{
"value": "CLICKLINK_SFTP",
"description": "ClickLink."
},
{
"value": "M3LOGISTICS",
"description": "M3 Logistics."
},
{
"value": "VNPOST_API",
"description": "Vietnam Post."
},
{
"value": "AXLEHIRE_FTP",
"description": "Axlehire."
},
{
"value": "SHADOWFAX",
"description": "Shadowfax."
},
{
"value": "MYHERMES_UK_API",
"description": "EVRi."
},
{
"value": "DAIICHI",
"description": "Daiichi Freight System Inc."
},
{
"value": "MENSAJEROSURBANOS_API",
"description": "Mensajeros Urbanos."
},
{
"value": "POLARSPEED",
"description": "PolarSpeed Inc."
},
{
"value": "IDEXPRESS_ID",
"description": "iDexpress Indonesia."
},
{
"value": "PAYO",
"description": "Payo."
},
{
"value": "WHISTL_SFTP",
"description": "Whistl."
},
{
"value": "INTEX_DE",
"description": "INTEX Paketdienst GmbH."
},
{
"value": "TRANS2U",
"description": "Trans2u."
},
{
"value": "PRODUCTCAREGROUP_SFTP",
"description": "Product Care Services Limited."
},
{
"value": "BIGSMART",
"description": "Big Smart."
},
{
"value": "EXPEDITORS_API_REF",
"description": "Expeditors API Reference."
},
{
"value": "AITWORLDWIDE_API",
"description": "AIT."
},
{
"value": "WORLDCOURIER",
"description": "World Courier."
},
{
"value": "QUIQUP",
"description": "Quiqup."
},
{
"value": "AGEDISS_SFTP",
"description": "Agediss."
},
{
"value": "ANDREANI_API",
"description": "Andreani."
},
{
"value": "CRLEXPRESS",
"description": "CRL Express."
},
{
"value": "SMARTCAT",
"description": "SMARTCAT."
},
{
"value": "CROSSFLIGHT",
"description": "Crossflight Limited."
},
{
"value": "PROCARRIER",
"description": "Pro Carrier."
},
{
"value": "DHL_REFERENCE_API",
"description": "DHL (Reference number)."
},
{
"value": "SEINO_API",
"description": "Seino."
},
{
"value": "WSPEXPRESS",
"description": "WSP Express."
},
{
"value": "KRONOS",
"description": "Kronos Express."
},
{
"value": "TOTAL_EXPRESS_API",
"description": "Total Express."
},
{
"value": "PARCLL",
"description": "PARCLL."
},
{
"value": "XPEDIGO",
"description": "Xpedigo."
},
{
"value": "STAR_TRACK_WEBHOOK",
"description": "StarTrack."
},
{
"value": "GPOST",
"description": "Georgian Post."
},
{
"value": "UCS",
"description": "UCS."
},
{
"value": "DMFGROUP",
"description": "DMF."
},
{
"value": "COORDINADORA_API",
"description": "Coordinadora."
},
{
"value": "MARKEN",
"description": "Marken."
},
{
"value": "NTL",
"description": "NTL logistics."
},
{
"value": "REDJEPAKKETJE",
"description": "Red je Pakketje."
},
{
"value": "ALLIED_EXPRESS_FTP",
"description": "Allied Express (FTP)."
},
{
"value": "MONDIALRELAY_ES",
"description": "Mondial Relay Spain(Punto Pack)."
},
{
"value": "NAEKO_FTP",
"description": "Naeko Logistics."
},
{
"value": "MHI",
"description": "Mhi."
},
{
"value": "SHIPPIFY",
"description": "Shippify, Inc."
},
{
"value": "MALCA_AMIT_API",
"description": "Malca Amit."
},
{
"value": "JTEXPRESS_SG_API",
"description": "J&T Express Singapore."
},
{
"value": "DACHSER_WEB",
"description": "DACHSER."
},
{
"value": "FLIGHTLG",
"description": "Flight Logistics Group."
},
{
"value": "CAGO",
"description": "Cago."
},
{
"value": "COM1EXPRESS",
"description": "ComOne Express."
},
{
"value": "TONAMI_FTP",
"description": "Tonami."
},
{
"value": "PACKFLEET",
"description": "PACKFLEET."
},
{
"value": "PUROLATOR_INTERNATIONAL",
"description": "Purolator International."
},
{
"value": "WINESHIPPING_WEBHOOK",
"description": "Wineshipping."
},
{
"value": "DHL_ES_SFTP",
"description": "DHL Spain Domestic."
},
{
"value": "PCHOME_API",
"description": "網家速配股份有限公司."
},
{
"value": "CESKAPOSTA_API",
"description": "Czech Post."
},
{
"value": "GORUSH",
"description": "Go Rush."
},
{
"value": "HOMERUNNER",
"description": "HomeRunner."
},
{
"value": "AMAZON_ORDER",
"description": "Amazon order."
},
{
"value": "EFWNOW_API",
"description": "Estes Forwarding Worldwide."
},
{
"value": "CBL_LOGISTICA_API",
"description": "CBL Logistica (API)."
},
{
"value": "NIMBUSPOST",
"description": "NimbusPost."
},
{
"value": "LOGWIN_LOGISTICS",
"description": "Logwin Logistics."
},
{
"value": "NOWLOG_API",
"description": "Sequoialog."
},
{
"value": "DPD_NL",
"description": "DPD Netherlands."
},
{
"value": "GODEPENDABLE",
"description": "Dependable Supply Chain Services."
},
{
"value": "ESDEX",
"description": "Top Ideal Express."
},
{
"value": "LOGISYSTEMS_SFTP",
"description": "Kiitäjät."
},
{
"value": "EXPEDITORS",
"description": "Expeditors."
},
{
"value": "SNTGLOBAL_API",
"description": "Snt Global Etrax."
},
{
"value": "SHIPX",
"description": "ShipX."
},
{
"value": "QINTL_API",
"description": "Quickstat Courier LLC."
},
{
"value": "PACKS",
"description": "Packs."
},
{
"value": "POSTNL_INTERNATIONAL",
"description": "PostNL International."
},
{
"value": "AMAZON_EMAIL_PUSH",
"description": "Amazon."
},
{
"value": "DHL_API",
"description": "DHL."
},
{
"value": "SPX",
"description": "Shopee Express."
},
{
"value": "AXLEHIRE",
"description": "AxleHire."
},
{
"value": "ICSCOURIER",
"description": "ICS COURIER."
},
{
"value": "DIALOGO_LOGISTICA",
"description": "Dialogo Logistica."
},
{
"value": "SHUNBANG_EXPRESS",
"description": "ShunBang Express."
},
{
"value": "TCS_API",
"description": "TCS."
},
{
"value": "SF_EXPRESS_CN",
"description": "SF Express China."
},
{
"value": "PACKETA",
"description": "Packeta."
},
{
"value": "SIC_TELIWAY",
"description": "Teliway SIC Express."
},
{
"value": "MONDIALRELAY_FR",
"description": "Mondial Relay France."
},
{
"value": "INTIME_FTP",
"description": "InTime."
},
{
"value": "JD_EXPRESS",
"description": "京东物流."
},
{
"value": "FASTBOX",
"description": "Fastbox."
},
{
"value": "PATHEON",
"description": "Patheon Logistics."
},
{
"value": "INDIA_POST",
"description": "India Post Domestic."
},
{
"value": "TIPSA_REF",
"description": "Tipsa Reference."
},
{
"value": "ECOFREIGHT",
"description": "Eco Freight."
},
{
"value": "VOX",
"description": "VOX SOLUCION EMPRESARIAL SRL."
},
{
"value": "DIRECTFREIGHT_AU_REF",
"description": "Direct Freight Express."
},
{
"value": "BESTTRANSPORT_SFTP",
"description": "Best Transport."
},
{
"value": "AUSTRALIA_POST_API",
"description": "Australia Post."
},
{
"value": "FRAGILEPAK_SFTP",
"description": "FragilePAK."
},
{
"value": "FLIPXP",
"description": "FlipXpress."
},
{
"value": "VALUE_WEBHOOK",
"description": "Value Logistics."
},
{
"value": "DAESHIN",
"description": "Daeshin."
},
{
"value": "SHERPA",
"description": "Sherpa."
},
{
"value": "MWD_API",
"description": "Metropolitan Warehouse & Delivery."
},
{
"value": "SMARTKARGO",
"description": "SmartKargo."
},
{
"value": "DNJ_EXPRESS",
"description": "DNJ Express."
},
{
"value": "GOPEOPLE",
"description": "Go People."
},
{
"value": "MYSENDLE_API",
"description": "mySendle."
},
{
"value": "ARAMEX_API",
"description": "Aramex."
},
{
"value": "PIDGE",
"description": "Pidge."
},
{
"value": "THAIPARCELS",
"description": "TP Logistic."
},
{
"value": "PANTHER_REFERENCE_API",
"description": "Panther Reference."
},
{
"value": "POSTAPLUS",
"description": "Posta Plus."
},
{
"value": "BUFFALO",
"description": "BUFFALO."
},
{
"value": "U_ENVIOS",
"description": "U-ENVIOS."
},
{
"value": "ELITE_CO",
"description": "Elite Express."
},
{
"value": "ROCHE_INTERNAL_SFTP",
"description": "Roche Internal Courier."
},
{
"value": "DBSCHENKER_ICELAND",
"description": "DB Schenker Iceland."
},
{
"value": "TNT_FR_REFERENCE",
"description": "TNT France Reference."
},
{
"value": "NEWGISTICSAPI",
"description": "Newgistics API."
},
{
"value": "GLOVO",
"description": "Glovo."
},
{
"value": "GWLOGIS_API",
"description": "G.I.G."
},
{
"value": "SPREETAIL_API",
"description": "Spreetail."
},
{
"value": "MOOVA",
"description": "Moova."
},
{
"value": "PLYCONGROUP",
"description": "Plycon Transportation Group."
},
{
"value": "USPS_WEBHOOK",
"description": "USPS Informed Visibility - Webhook."
},
{
"value": "REIMAGINEDELIVERY",
"description": "maergo."
},
{
"value": "EDF_FTP",
"description": "Eurodifarm."
},
{
"value": "DAO365",
"description": "DAO365."
},
{
"value": "BIOCAIR_FTP",
"description": "BioCair."
},
{
"value": "RANSA_WEBHOOK",
"description": "Ransa."
},
{
"value": "SHIPXPRES",
"description": "SHIPXPRESS."
},
{
"value": "COURANT_PLUS_API",
"description": "Courant Plus."
},
{
"value": "SHIPA",
"description": "SHIPA."
},
{
"value": "HOMELOGISTICS",
"description": "Home Logistics."
},
{
"value": "DX",
"description": "DX."
},
{
"value": "POSTE_ITALIANE_PACCOCELERE",
"description": "Poste Italiane Paccocelere."
},
{
"value": "TOLL_WEBHOOK",
"description": "Toll Group."
},
{
"value": "LCTBR_API",
"description": "LCT do Brasil."
},
{
"value": "DX_FREIGHT",
"description": "DX Freight."
},
{
"value": "DHL_SFTP",
"description": "DHL Express."
},
{
"value": "SHIPROCKET",
"description": "Shiprocket X."
},
{
"value": "UBER_WEBHOOK",
"description": "Uber."
},
{
"value": "STATOVERNIGHT",
"description": "Stat Overnight."
},
{
"value": "BURD",
"description": "Burd Delivery."
},
{
"value": "FASTSHIP",
"description": "Fastship Express."
},
{
"value": "IBVENTURE_WEBHOOK",
"description": "IB Venture."
},
{
"value": "GATI_KWE_API",
"description": "Gati-KWE."
},
{
"value": "CRYOPDP_FTP",
"description": "CryoPDP."
},
{
"value": "HUBBED",
"description": "HUBBED."
},
{
"value": "TIPSA_API",
"description": "Tipsa API."
},
{
"value": "ARASKARGO",
"description": "Aras Cargo."
},
{
"value": "THIJS_NL",
"description": "Thijs Logistiek."
},
{
"value": "ATSHEALTHCARE_REFERENCE",
"description": "ATS Healthcare."
},
{
"value": "99MINUTOS",
"description": "99minutos."
},
{
"value": "HELLENIC_POST",
"description": "Hellenic (Greece) Post."
},
{
"value": "HSM_GLOBAL",
"description": "HSM Global."
},
{
"value": "MNX",
"description": "MNX."
},
{
"value": "NMTRANSFER",
"description": "N&M Transfer Co., Inc.."
},
{
"value": "LOGYSTO",
"description": "Logysto."
},
{
"value": "INDIA_POST_INT",
"description": "India Post International."
},
{
"value": "AMAZON_FBA_SWISHIP_IN",
"description": "Swiship IN."
},
{
"value": "SRT_TRANSPORT",
"description": "SRT Transport."
},
{
"value": "BOMI",
"description": "Bomi Group."
},
{
"value": "DELIVERR_SFTP",
"description": "Deliverr."
},
{
"value": "HSDEXPRESS",
"description": "HSDEXPRESS."
},
{
"value": "SIMPLETIRE_WEBHOOK",
"description": "SimpleTire."
},
{
"value": "HUNTER_EXPRESS_SFTP",
"description": "Hunter Express."
},
{
"value": "UPS_API",
"description": "UPS."
},
{
"value": "WOOYOUNG_LOGISTICS_SFTP",
"description": "WOO YOUNG LOGISTICS CO.,LTD.."
},
{
"value": "PHSE_API",
"description": "PHSE."
},
{
"value": "WISH_EMAIL_PUSH",
"description": "Wish."
},
{
"value": "NORTHLINE",
"description": "Northline."
},
{
"value": "MEDAFRICA",
"description": "Med Africa Logistics."
},
{
"value": "DPD_AT_SFTP",
"description": "DPD Austria."
},
{
"value": "ANTERAJA",
"description": "Anteraja."
},
{
"value": "DHL_GLOBAL_FORWARDING_API",
"description": "DHL Global Forwarding API."
},
{
"value": "LBCEXPRESS_API",
"description": "LBC EXPRESS INC.."
},
{
"value": "SIMSGLOBAL",
"description": "Sims Global."
},
{
"value": "CDLDELIVERS",
"description": "CDL Last Mile."
},
{
"value": "TYP",
"description": "TYP."
},
{
"value": "TESTING_COURIER_WEBHOOK",
"description": "Testing Courier."
},
{
"value": "PANDAGO_API",
"description": "Pandago."
},
{
"value": "ROYAL_MAIL_FTP",
"description": "Royal Mail."
},
{
"value": "THUNDEREXPRESS",
"description": "Thunder Express Australia."
},
{
"value": "SECRETLAB_WEBHOOK",
"description": "Secretlab."
},
{
"value": "SETEL",
"description": "Setel Express."
},
{
"value": "JD_WORLDWIDE",
"description": "JD Worldwide."
},
{
"value": "DPD_RU_API",
"description": "DPD Russia."
},
{
"value": "ARGENTS_WEBHOOK",
"description": "Argents Express Group."
},
{
"value": "POSTONE",
"description": "Post ONE."
},
{
"value": "TUSKLOGISTICS",
"description": "Tusk Logistics."
},
{
"value": "RHENUS_UK_API",
"description": "Rhenus Logistics UK."
},
{
"value": "TAQBIN_SG_API",
"description": "Yamato Singapore."
},
{
"value": "INNTRALOG_SFTP",
"description": "Inntralog GmbH."
},
{
"value": "DAYROSS",
"description": "Day & Ross."
},
{
"value": "CORREOSEXPRESS_API",
"description": "Correos Express (API)."
},
{
"value": "INTERNATIONAL_SEUR_API",
"description": "International Seur API."
},
{
"value": "YODEL_API",
"description": "Yodel API."
},
{
"value": "HEROEXPRESS",
"description": "Hero Express."
},
{
"value": "DHL_SUPPLYCHAIN_IN",
"description": "DHL supply chain India."
},
{
"value": "URGENT_CARGUS",
"description": "Urgent Cargus."
},
{
"value": "FRONTDOORCORP",
"description": "FRONTdoor Collective."
},
{
"value": "JTEXPRESS_PH",
"description": "J&T Express Philippines."
},
{
"value": "PARCELSTARS_WEBHOOK",
"description": "Parcelstars."
},
{
"value": "DPD_SK_SFTP",
"description": "DPD Slovakia."
},
{
"value": "MOVIANTO",
"description": "Movianto."
},
{
"value": "OZEPARTS_SHIPPING",
"description": "Ozeparts Shipping."
},
{
"value": "KARGOMKOLAY",
"description": "KargomKolay (CargoMini)."
},
{
"value": "TRUNKRS",
"description": "Trunkrs."
},
{
"value": "OMNIRPS_WEBHOOK",
"description": "Omni Returns."
},
{
"value": "CHILEXPRESS",
"description": "Chile Express."
},
{
"value": "TESTING_COURIER",
"description": "Testing Courier."
},
{
"value": "JNE_API",
"description": "JNE (API)."
},
{
"value": "BJSHOMEDELIVERY_FTP",
"description": "BJS Distribution, Storage & Couriers - FTP."
},
{
"value": "DEXPRESS_WEBHOOK",
"description": "D Express."
},
{
"value": "USPS_API",
"description": "USPS API."
},
{
"value": "TRANSVIRTUAL",
"description": "TransVirtual."
},
{
"value": "SOLISTICA_API",
"description": "solistica."
},
{
"value": "CHIENVENTURE_WEBHOOK",
"description": "Chienventure."
},
{
"value": "DPD_UK_SFTP",
"description": "DPD UK."
},
{
"value": "INPOST_UK",
"description": "InPost."
},
{
"value": "JAVIT",
"description": "Javit."
},
{
"value": "ZTO_DOMESTIC",
"description": "ZTO Express China."
},
{
"value": "DHL_GT_API",
"description": "DHL Global Forwarding Guatemala."
},
{
"value": "CEVA_TRACKING",
"description": "CEVA Package."
},
{
"value": "KOMON_EXPRESS",
"description": "Komon Express."
},
{
"value": "EASTWESTCOURIER_FTP",
"description": "East West Courier Pte Ltd."
},
{
"value": "DANNIAO",
"description": "Danniao."
},
{
"value": "SPECTRAN",
"description": "Spectran."
},
{
"value": "DELIVER_IT",
"description": "Deliver-iT."
},
{
"value": "RELAISCOLIS",
"description": "Relais Colis."
},
{
"value": "GLS_SPAIN_API",
"description": "GLS Spain."
},
{
"value": "POSTPLUS",
"description": "PostPlus."
},
{
"value": "AIRTERRA",
"description": "Airterra."
},
{
"value": "GIO_ECOURIER_API",
"description": "GIO Express Ecourier."
},
{
"value": "DPD_CH_SFTP",
"description": "DPD Switzerland."
},
{
"value": "FEDEX_API",
"description": "FedEx®."
},
{
"value": "INTERSMARTTRANS",
"description": "INTERSMARTTRANS & SOLUTIONS SL."
},
{
"value": "HERMES_UK_SFTP",
"description": "Hermes UK."
},
{
"value": "EXELOT_FTP",
"description": "Exelot Ltd.."
},
{
"value": "DHL_PA_API",
"description": "DHL GLOBAL FORWARDING PANAMÁ."
},
{
"value": "VIRTRANSPORT_SFTP",
"description": "Vir Transport."
},
{
"value": "WORLDNET",
"description": "Worldnet Logistics."
},
{
"value": "INSTABOX_WEBHOOK",
"description": "Instabox."
},
{
"value": "KNG",
"description": "Keuhne + Nagel Global."
},
{
"value": "FLASHEXPRESS_WEBHOOK",
"description": "Flash Express."
},
{
"value": "MAGYAR_POSTA_API",
"description": "Magyar Posta."
},
{
"value": "WESHIP_API",
"description": "WeShip."
},
{
"value": "OHI_WEBHOOK",
"description": "Ohi."
},
{
"value": "MUDITA",
"description": "MUDITA."
},
{
"value": "BLUEDART_API",
"description": "Bluedart."
},
{
"value": "T_CAT_API",
"description": "T-cat."
},
{
"value": "ADS",
"description": "ADS Express."
},
{
"value": "HERMES_IT",
"description": "HR Parcel."
},
{
"value": "FITZMARK_API",
"description": "FitzMark."
},
{
"value": "POSTI_API",
"description": "Posti API."
},
{
"value": "SMSA_EXPRESS_WEBHOOK",
"description": "SMSA Express."
},
{
"value": "TAMERGROUP_WEBHOOK",
"description": "Tamer Logistics."
},
{
"value": "LIVRAPIDE",
"description": "Livrapide."
},
{
"value": "NIPPON_EXPRESS",
"description": "Nippon Express."
},
{
"value": "BETTERTRUCKS",
"description": "Better Trucks."
},
{
"value": "FAN",
"description": "FAN COURIER EXPRESS."
},
{
"value": "PB_USPSFLATS_FTP",
"description": "USPS Flats (Pitney Bowes)."
},
{
"value": "PARCELRIGHT",
"description": "Parcel Right."
},
{
"value": "ITHINKLOGISTICS",
"description": "iThink Logistics."
},
{
"value": "KERRY_EXPRESS_TH_WEBHOOK",
"description": "Kerry Logistics."
},
{
"value": "ECOUTIER",
"description": "eCoutier."
},
{
"value": "SHOWL",
"description": "SENHONG INTERNATIONAL LOGISTICS."
},
{
"value": "BRT_IT_API",
"description": "BRT Bartolini API."
},
{
"value": "RIXONHK_API",
"description": "Rixon Logistics."
},
{
"value": "DBSCHENKER_API",
"description": "DB Schenker."
},
{
"value": "ILYANGLOGIS",
"description": "Ilyang logistics."
},
{
"value": "MAIL_BOX_ETC",
"description": "Mail Boxes Etc.."
},
{
"value": "WESHIP",
"description": "WeShip."
},
{
"value": "DHL_GLOBAL_MAIL_API",
"description": "DHL eCommerce Solutions."
},
{
"value": "ACTIVOS24_API",
"description": "Activos24."
},
{
"value": "ATSHEALTHCARE",
"description": "ATS Healthcare."
},
{
"value": "LUWJISTIK",
"description": "Luwjistik."
},
{
"value": "GW_WORLD",
"description": "Gebrüder Weiss."
},
{
"value": "FAIRSENDEN_API",
"description": "fairsenden."
},
{
"value": "SERVIP_WEBHOOK",
"description": "SerVIP."
},
{
"value": "SWISHIP",
"description": "Swiship."
},
{
"value": "TANET",
"description": "Transport Ambientales."
},
{
"value": "HOTSIN_CARGO",
"description": "SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD."
},
{
"value": "DIREX",
"description": "Direx."
},
{
"value": "HUANTONG",
"description": "HuanTong."
},
{
"value": "IMILE_API",
"description": "iMile."
},
{
"value": "AUEXPRESS",
"description": "Au Express."
},
{
"value": "NYTLOGISTICS",
"description": "NYT SUPPLY CHAIN LOGISTICS Co.,LTD."
},
{
"value": "DSV_REFERENCE",
"description": "DSV Futurewave."
},
{
"value": "NOVOFARMA_WEBHOOK",
"description": "Novofarma."
},
{
"value": "AITWORLDWIDE_SFTP",
"description": "AIT."
},
{
"value": "SHOPOLIVE",
"description": "Olive."
},
{
"value": "FNF_ZA",
"description": "Fast & Furious."
},
{
"value": "DHL_ECOMMERCE_GC",
"description": "DHL eCommerce Greater China."
},
{
"value": "FETCHR",
"description": "Fetchr."
},
{
"value": "STARLINKS_API",
"description": "Starlinks Global."
},
{
"value": "YYEXPRESS",
"description": "YYEXPRESS."
},
{
"value": "SERVIENTREGA",
"description": "Servientrega."
},
{
"value": "HANJIN",
"description": "HanJin."
},
{
"value": "SPANISH_SEUR_FTP",
"description": "Spanish Seur."
},
{
"value": "DX_B2B_CONNUM",
"description": "DX (B2B)."
},
{
"value": "HELTHJEM_API",
"description": "Helthjem."
},
{
"value": "INEXPOST",
"description": "Inexpost."
},
{
"value": "A2B_BA",
"description": "A2B Express Logistics."
},
{
"value": "RHENUS_GROUP",
"description": "Rhenus Logistics."
},
{
"value": "SBERLOGISTICS_RU",
"description": "Sber Logistics."
},
{
"value": "MALCA_AMIT",
"description": "Malca-Amit."
},
{
"value": "PPL",
"description": "Professional Parcel Logistics."
},
{
"value": "OSM_WORLDWIDE_SFTP",
"description": "OSM Worldwide."
},
{
"value": "ACILOGISTIX",
"description": "ACI Logistix."
},
{
"value": "OPTIMACOURIER",
"description": "Optima Courier."
},
{
"value": "NOVA_POSHTA_API",
"description": "Nova Poshta API."
},
{
"value": "LOGGI",
"description": "Loggi."
},
{
"value": "YIFAN",
"description": "YiFan Express."
},
{
"value": "MYDYNALOGIC",
"description": "My DynaLogic."
},
{
"value": "MORNINGLOBAL",
"description": "Morning Global."
},
{
"value": "CONCISE_API",
"description": "Concise."
},
{
"value": "FXTRAN",
"description": "Falcon Express."
},
{
"value": "DELIVERYOURPARCEL_ZA",
"description": "Deliver Your Parcel."
},
{
"value": "UPARCEL",
"description": "uParcel."
},
{
"value": "MOBI_BR",
"description": "Mobi Logistica."
},
{
"value": "LOGINEXT_WEBHOOK",
"description": "T&W Delivery."
},
{
"value": "EMS",
"description": "EMS."
},
{
"value": "SPEEDY",
"description": "Speedy."
},
{
"value": "ZOOM_RED",
"description": "Zoom."
},
{
"value": "NAVLUNGO",
"description": "Navlungo."
},
{
"value": "CASTLEPARCELS",
"description": "Castle Parcels."
},
{
"value": "WEEE",
"description": "Weee."
},
{
"value": "PACKALY",
"description": "Packaly."
},
{
"value": "YUNHUIPOST",
"description": "Yunhuipost."
},
{
"value": "YOUPARCEL",
"description": "YouParcel."
},
{
"value": "LEMAN",
"description": "Leman."
},
{
"value": "MOOVIN",
"description": "Moovin."
},
{
"value": "URB_IT",
"description": "Urb-it."
},
{
"value": "MULTIENTREGAPANAMA",
"description": "Multientrega."
},
{
"value": "JUSDASR",
"description": "Jusdasr."
},
{
"value": "DISCOUNTPOST",
"description": "Discount Post."
},
{
"value": "RHENUS_UK",
"description": "Rhenus Logistics UK."
},
{
"value": "SWISHIP_JP",
"description": "Swiship JP."
},
{
"value": "GLS_US",
"description": "GLS USA."
},
{
"value": "SMTL",
"description": "Southwestern Motor Transport. Inc."
},
{
"value": "EMEGA",
"description": "Discount Post Emega."
},
{
"value": "EXPRESSONE_SV",
"description": "EXPRESSONE Slovenia."
},
{
"value": "HEPSIJET",
"description": "hepsiJET."
},
{
"value": "WELIVERY",
"description": "Welivery."
},
{
"value": "BRINGER",
"description": "Bringer Parcel Services."
},
{
"value": "EASYROUTES",
"description": "EasyRoutes."
},
{
"value": "MRW",
"description": "MRW."
},
{
"value": "RPM",
"description": "RPM."
},
{
"value": "DPD_PRT",
"description": "DPD Portugal."
},
{
"value": "GLS_ROMANIA",
"description": "GLS Romania."
},
{
"value": "LMPARCEL",
"description": "LM Parcel."
},
{
"value": "GTAGSM",
"description": "GTA GSM."
},
{
"value": "DOMINO",
"description": "DOMINO."
},
{
"value": "ESHIPPER",
"description": "eShipper."
},
{
"value": "TRANSPAK",
"description": "Transpak Inc.."
},
{
"value": "XINDUS",
"description": "Xindus."
},
{
"value": "AOYUE",
"description": "Aoyue."
},
{
"value": "EASYPARCEL",
"description": "Easyparcel."
},
{
"value": "EXPRESSONE",
"description": "EXPRESSONE."
},
{
"value": "SENDEO_KARGO",
"description": "Sendeo Kargo."
},
{
"value": "SPEEDAF",
"description": "Speedaf Express."
},
{
"value": "ETOWER",
"description": "eTower."
},
{
"value": "GCX",
"description": "GC Express."
},
{
"value": "NINJAVAN_VN",
"description": "Ninjavan Vietnam."
},
{
"value": "ALLEGRO",
"description": "Allegro."
},
{
"value": "JUMPPOINT",
"description": "Jumppoint."
},
{
"value": "SHIPGLOBAL_US",
"description": "ShipGlobal."
},
{
"value": "KINISI",
"description": "Kinisi Transport Pty Ltd."
},
{
"value": "OAKH",
"description": "Oakh Harbour Freight Lines."
},
{
"value": "AWEST",
"description": "American West."
},
{
"value": "BARSAN",
"description": "Barsan Global Lojistik."
},
{
"value": "ENERGOLOGISTIC",
"description": "Energo Logistic."
},
{
"value": "MADROOEX",
"description": "Madrooex."
},
{
"value": "GOBOLT",
"description": "GoBolt."
},
{
"value": "SWISS_UNIVERSAL_EXPRESS",
"description": "Swiss Universal Express."
},
{
"value": "IORDIRECT",
"description": "IOR Direct Solutions."
},
{
"value": "XMSZM",
"description": "xmszm."
},
{
"value": "GLS_HUN",
"description": "GLS Hungary."
},
{
"value": "SENDY",
"description": "Sendy Express."
},
{
"value": "BRAUNSEXPRESS",
"description": "Brauns Express."
},
{
"value": "GRANDSLAMEXPRESS",
"description": "Grand Slam Express."
},
{
"value": "XGS",
"description": "XGS."
},
{
"value": "OTSCHILE",
"description": "OTS."
},
{
"value": "PACK_UP",
"description": "Pack-Up."
},
{
"value": "PARCELSTARS",
"description": "Parcelstars."
},
{
"value": "TEAMEXPRESSLLC",
"description": "Team Express Service LLC."
},
{
"value": "ASYADEXPRESS",
"description": "Asyad Express."
},
{
"value": "TDN",
"description": "TDN."
},
{
"value": "EARLYBIRD",
"description": "Early Bird."
},
{
"value": "CACESA",
"description": "Cacesa."
},
{
"value": "PARCELJET",
"description": "Parceljet."
},
{
"value": "MNG_KARGO",
"description": "MNG Kargo."
},
{
"value": "SUPERPACKLINE",
"description": "Super Pac Line."
},
{
"value": "SPEEDX",
"description": "SpeedX."
},
{
"value": "VESYL",
"description": "Vesyl."
},
{
"value": "SKYKING",
"description": "Sky King."
},
{
"value": "DIRMENSAJERIA",
"description": "DIR."
},
{
"value": "NETLOGIXGROUP",
"description": "Netlogix."
},
{
"value": "ZYOU",
"description": "ZYEX."
},
{
"value": "JAWAR",
"description": "Jawar."
},
{
"value": "AGSYSTEMS",
"description": "Associate Global Systems."
},
{
"value": "GPS",
"description": "GPS."
},
{
"value": "PTT_KARGO",
"description": "PTT Kargo."
},
{
"value": "MAERGO",
"description": "Maergo."
},
{
"value": "ARIHANTCOURIER",
"description": "AICS."
},
{
"value": "VTFE",
"description": "VicTas Freight Express."
},
{
"value": "YUNANT",
"description": "Yunant."
},
{
"value": "URBIFY",
"description": "Urbify."
},
{
"value": "PACK_MAN",
"description": "pack-man."
},
{
"value": "LIEFERGRUN",
"description": "LIEFERGRUN."
},
{
"value": "OBIBOX",
"description": "Obibox."
},
{
"value": "PAIKEDA",
"description": "Paikeda."
},
{
"value": "SCOTTY",
"description": "Scotty."
},
{
"value": "INTELCOM_CA",
"description": "Intelcom."
},
{
"value": "SWE",
"description": "swe."
},
{
"value": "ASENDIA",
"description": "Asendia Global."
},
{
"value": "DPD_AT",
"description": "DPD Austria."
},
{
"value": "RELAY",
"description": "Relay."
},
{
"value": "ATA",
"description": "ATA."
},
{
"value": "SKYEXPRESS_INTERNATIONAL",
"description": "SkyExpress Internationals."
},
{
"value": "SURAT_KARGO",
"description": "Surat Kargo."
},
{
"value": "SGLINK",
"description": "SG LINK."
},
{
"value": "FLEETOPTICSINC",
"description": "FleetOptics."
},
{
"value": "SHOPLINE",
"description": "shopline."
},
{
"value": "PIGGYSHIP",
"description": "PIGGYSHIP."
},
{
"value": "LOGOIX",
"description": "LogoiX."
},
{
"value": "KOLAY_GELSIN",
"description": "Kolay Gelsin."
},
{
"value": "ASSOCIATED_COURIERS",
"description": "Associated Couriers."
},
{
"value": "UPS_CHECKER",
"description": "ups-checker."
},
{
"value": "WINESHIPPING",
"description": "Wineshipping."
},
{
"value": "SPEDISCI",
"description": "Spedisci online."
}
],
"enum": [
"DPD_RU",
"BG_BULGARIAN_POST",
"KR_KOREA_POST",
"ZA_COURIERIT",
"FR_EXAPAQ",
"ARE_EMIRATES_POST",
"GAC",
"GEIS",
"SF_EX",
"PAGO",
"MYHERMES",
"DIAMOND_EUROGISTICS",
"CORPORATECOURIERS_WEBHOOK",
"BOND",
"OMNIPARCEL",
"SK_POSTA",
"PUROLATOR",
"FETCHR_WEBHOOK",
"THEDELIVERYGROUP",
"CELLO_SQUARE",
"TARRIVE",
"COLLIVERY",
"MAINFREIGHT",
"IND_FIRSTFLIGHT",
"ACSWORLDWIDE",
"AMSTAN",
"OKAYPARCEL",
"ENVIALIA_REFERENCE",
"SEUR_ES",
"CONTINENTAL",
"FDSEXPRESS",
"AMAZON_FBA_SWISHIP",
"WYNGS",
"DHL_ACTIVE_TRACING",
"ZYLLEM",
"RUSTON",
"XPOST",
"CORREOS_ES",
"DHL_FR",
"PAN_ASIA",
"BRT_IT",
"SRE_KOREA",
"SPEEDEE",
"TNT_UK",
"VENIPAK",
"SHREENANDANCOURIER",
"CROSHOT",
"NIPOST_NG",
"EPST_GLBL",
"NEWGISTICS",
"POST_SLOVENIA",
"JERSEY_POST",
"BOMBINOEXP",
"WMG",
"XQ_EXPRESS",
"FURDECO",
"LHT_EXPRESS",
"SOUTH_AFRICAN_POST_OFFICE",
"SPOTON",
"DIMERCO",
"CYPRUS_POST_CYP",
"ABCUSTOM",
"IND_DELIVREE",
"CN_BESTEXPRESS",
"DX_SFTP",
"PICKUPP_MYS",
"FMX",
"HELLMANN",
"SHIP_IT_ASIA",
"KERRY_ECOMMERCE",
"FRETERAPIDO",
"PITNEY_BOWES",
"XPRESSEN_DK",
"SEUR_SP_API",
"DELIVERYONTIME",
"JINSUNG",
"TRANS_KARGO",
"SWISHIP_DE",
"IVOY_WEBHOOK",
"AIRMEE_WEBHOOK",
"DHL_BENELUX",
"FIRSTMILE",
"FASTWAY_IR",
"HH_EXP",
"MYS_MYPOST_ONLINE",
"TNT_NL",
"TIPSA",
"TAQBIN_MY",
"KGMHUB",
"INTEXPRESS",
"OVERSE_EXP",
"ONECLICK",
"ROADRUNNER_FREIGHT",
"GLS_CROTIA",
"MRW_FTP",
"BLUEX",
"DYLT",
"DPD_IR",
"SIN_GLBL",
"TUFFNELLS_REFERENCE",
"CJPACKET",
"MILKMAN",
"ASIGNA",
"ONEWORLDEXPRESS",
"ROYAL_MAIL",
"VIA_EXPRESS",
"TIGFREIGHT",
"ZTO_EXPRESS",
"TWO_GO",
"IML",
"INTEL_VALLEY",
"EFS",
"UK_UK_MAIL",
"RAM",
"ALLIEDEXPRESS",
"APC_OVERNIGHT",
"SHIPPIT",
"TFM",
"M_XPRESS",
"HDB_BOX",
"CLEVY_LINKS",
"IBEONE",
"FIEGE_NL",
"KWE_GLOBAL",
"CTC_EXPRESS",
"AMAZON",
"MORE_LINK",
"JX",
"EASY_MAIL",
"ADUIEPYLE",
"GB_PANTHER",
"EXPRESSSALE",
"SG_DETRACK",
"TRUNKRS_WEBHOOK",
"MATDESPATCH",
"DICOM",
"MBW",
"KHM_CAMBODIA_POST",
"SINOTRANS",
"BRT_IT_PARCELID",
"DHL_SUPPLY_CHAIN",
"DHL_PL",
"TOPYOU",
"PALEXPRESS",
"DHL_SG",
"CN_WEDO",
"FULFILLME",
"DPD_DELISTRACK",
"UPS_REFERENCE",
"CARIBOU",
"LOCUS_WEBHOOK",
"DSV",
"P2P_TRC",
"DIRECTPARCELS",
"NOVA_POSHTA_INT",
"FEDEX_POLAND",
"CN_JCEX",
"FAR_INTERNATIONAL",
"IDEXPRESS",
"GANGBAO",
"NEWAY",
"POSTNL_INT_3_S",
"RPX_ID",
"DESIGNERTRANSPORT_WEBHOOK",
"GLS_SLOVEN",
"PARCELLED_IN",
"GSI_EXPRESS",
"CON_WAY",
"BROUWER_TRANSPORT",
"CPEX",
"ISRAEL_POST",
"DTDC_IN",
"PTT_POST",
"XDE_WEBHOOK",
"TOLOS",
"GIAO_HANG",
"GEODIS_ESPACE",
"MAGYAR_HU",
"DOORDASH_WEBHOOK",
"TIKI_ID",
"CJ_HK_INTERNATIONAL",
"STAR_TRACK_EXPRESS",
"HELTHJEM",
"SFB2C",
"FREIGHTQUOTE",
"LANDMARK_GLOBAL_REFERENCE",
"PARCEL2GO",
"DELNEXT",
"RCL",
"CGS_EXPRESS",
"HK_POST",
"SAP_EXPRESS",
"PARCELPOST_SG",
"HERMES",
"IND_SAFEEXPRESS",
"TOPHATTEREXPRESS",
"MGLOBAL",
"AVERITT",
"LEADER",
"_2EBOX",
"SG_SPEEDPOST",
"DBSCHENKER_SE",
"ISR_POST_DOMESTIC",
"BESTWAYPARCEL",
"ASENDIA_DE",
"NIGHTLINE_UK",
"TAQBIN_SG",
"TCK_EXPRESS",
"ENDEAVOUR_DELIVERY",
"NANJINGWOYUAN",
"HEPPNER_FR",
"EMPS_CN",
"FONSEN",
"PICKRR",
"APC_OVERNIGHT_CONNUM",
"STAR_TRACK_NEXT_FLIGHT",
"DAJIN",
"UPS_FREIGHT",
"POSTA_PLUS",
"CEVA",
"ANSERX",
"JS_EXPRESS",
"PADTF",
"UPS_MAIL_INNOVATIONS",
"SYPOST",
"AMAZON_SHIP_MCF",
"YUSEN",
"BRING",
"SDA_IT",
"GBA",
"NEWEGGEXPRESS",
"SPEEDCOURIERS_GR",
"FORRUN",
"PICKUP",
"ECMS",
"INTELIPOST",
"FLASHEXPRESS",
"CN_STO",
"SEKO_SFTP",
"HOME_DELIVERY_SOLUTIONS",
"DPD_HGRY",
"KERRYTTC_VN",
"JOYING_BOX",
"TOTAL_EXPRESS",
"ZJS_EXPRESS",
"STARKEN",
"DEMANDSHIP",
"CN_DPEX",
"AUPOST_CN",
"LOGISTERS",
"GOGLOBALPOST",
"GLS_CZ",
"PAACK_WEBHOOK",
"GRAB_WEBHOOK",
"PARCELPOINT",
"ICUMULUS",
"DAIGLOBALTRACK",
"GLOBAL_IPARCEL",
"YURTICI_KARGO",
"CN_PAYPAL_PACKAGE",
"PARCEL_2_POST",
"GLS_IT",
"PIL_LOGISTICS",
"HEPPNER",
"GENERAL_OVERNIGHT",
"HAPPY2POINT",
"CHITCHATS",
"SMOOTH",
"CLE_LOGISTICS",
"FIEGE",
"MX_CARGO",
"ZIINGFINALMILE",
"DAYTON_FREIGHT",
"TCS",
"AEX",
"HERMES_DE",
"ROUTIFIC_WEBHOOK",
"GLOBAVEND",
"CJ_LOGISTICS",
"PALLET_NETWORK",
"RAF_PH",
"UK_XDP",
"PAPER_EXPRESS",
"LA_POSTE_SUIVI",
"PAQUETEXPRESS",
"LIEFERY",
"STRECK_TRANSPORT",
"PONY_EXPRESS",
"ALWAYS_EXPRESS",
"GBS_BROKER",
"CITYLINK_MY",
"ALLJOY",
"YODEL",
"YODEL_DIR",
"STONE3PL",
"PARCELPAL_WEBHOOK",
"DHL_ECOMERCE_ASA",
"SIMPLYPOST",
"KY_EXPRESS",
"SHENZHEN",
"US_LASERSHIP",
"UC_EXPRE",
"DIDADI",
"CJ_KR",
"DBSCHENKER_B2B",
"MXE",
"CAE_DELIVERS",
"PFCEXPRESS",
"WHISTL",
"WEPOST",
"DHL_PARCEL_ES",
"DDEXPRESS",
"ARAMEX_AU",
"BNEED",
"HK_TGX",
"LATVIJAS_PASTS",
"VIAEUROPE",
"CORREO_UY",
"CHRONOPOST_FR",
"J_NET",
"_6LS",
"BLR_BELPOST",
"BIRDSYSTEM",
"DOBROPOST",
"WAHANA_ID",
"WEASHIP",
"SONICTL",
"KWT",
"AFLLOG_FTP",
"SKYNET_WORLDWIDE",
"NOVA_POSHTA",
"SEINO",
"SZENDEX",
"BPOST_INT",
"DBSCHENKER_SV",
"AO_DEUTSCHLAND",
"EU_FLEET_SOLUTIONS",
"PCFCORP",
"LINKBRIDGE",
"PRIMAMULTICIPTA",
"COUREX",
"ZAJIL_EXPRESS",
"COLLECTCO",
"JTEXPRESS",
"FEDEX_UK",
"USHIP",
"PIXSELL",
"SHIPTOR",
"CDEK",
"VNM_VIETTELPOST",
"CJ_CENTURY",
"GSO",
"VIWO",
"SKYBOX",
"KERRYTJ",
"NTLOGISTICS_VN",
"SDH_SCM",
"ZINC",
"DPE_SOUTH_AFRC",
"CESKA_CZ",
"ACS_GR",
"DEALERSEND",
"JOCOM",
"CSE",
"TFORCE_FINALMILE",
"SHIP_GATE",
"SHIPTER",
"NATIONAL_SAMEDAY",
"YUNEXPRESS",
"CAINIAO",
"DMS_MATRIX",
"DIRECTLOG",
"ASENDIA_US",
"_3JMSLOGISTICS",
"LICCARDI_EXPRESS",
"SKY_POSTAL",
"CNWANGTONG",
"POSTNORD_LOGISTICS_DK",
"LOGISTIKA",
"CELERITAS",
"PRESSIODE",
"SHREE_MARUTI",
"LOGISTICSWORLDWIDE_HK",
"EFEX",
"LOTTE",
"LONESTAR",
"APRISAEXPRESS",
"BEL_RS",
"OSM_WORLDWIDE",
"WESTGATE_GL",
"FASTRACK",
"DTD_EXPR",
"ALFATREX",
"PROMEDDELIVERY",
"THABIT_LOGISTICS",
"HCT_LOGISTICS",
"CARRY_FLAP",
"US_OLD_DOMINION",
"ANICAM_BOX",
"WANBEXPRESS",
"AN_POST",
"DPD_LOCAL",
"STALLIONEXPRESS",
"RAIDEREX",
"SHOPFANS",
"KYUNGDONG_PARCEL",
"CHAMPION_LOGISTICS",
"PICKUPP_SGP",
"MORNING_EXPRESS",
"NACEX",
"THENILE_WEBHOOK",
"HOLISOL",
"LBCEXPRESS_FTP",
"KURASI",
"USF_REDDAWAY",
"APG",
"CN_BOXC",
"ECOSCOOTING",
"MAINWAY",
"PAPERFLY",
"HOUNDEXPRESS",
"BOX_BERRY",
"EP_BOX",
"PLUS_LOG_UK",
"FULFILLA",
"ASE",
"MAIL_PLUS",
"XPO_LOGISTICS",
"WNDIRECT",
"CLOUDWISH_ASIA",
"ZELERIS",
"GIO_EXPRESS",
"OCS_WORLDWIDE",
"ARK_LOGISTICS",
"AQUILINE",
"PILOT_FREIGHT",
"QWINTRY",
"DANSKE_FRAGT",
"CARRIERS",
"AIR_CANADA_GLOBAL",
"PRESIDENT_TRANS",
"STEPFORWARDFS",
"SKYNET_UK",
"PITTOHIO",
"CORREOS_EXPRESS",
"RL_US",
"DESTINY",
"UK_YODEL",
"COMET_TECH",
"DHL_PARCEL_RU",
"TNT_REFR",
"SHREE_ANJANI_COURIER",
"MIKROPAKKET_BE",
"ETS_EXPRESS",
"COLIS_PRIVE",
"CN_YUNDA",
"AAA_COOPER",
"ROCKET_PARCEL",
"_360LION",
"PANDU",
"PROFESSIONAL_COURIERS",
"FLYTEXPRESS",
"LOGISTICSWORLDWIDE_MY",
"CORREOS_DE_ESPANA",
"IMX",
"FOUR_PX_EXPRESS",
"XPRESSBEES",
"PICKUPP_VNM",
"STARTRACK_EXPRESS",
"FR_COLISSIMO",
"NACEX_SPAIN_REFERENCE",
"DHL_SUPPLY_CHAIN_AU",
"ESHIPPING",
"SHREETIRUPATI",
"HX_EXPRESS",
"INDOPAKET",
"CN_17POST",
"K1_EXPRESS",
"CJ_GLS",
"MYS_GDEX",
"NATIONEX",
"ANJUN",
"FARGOOD",
"SMG_EXPRESS",
"RZYEXPRESS",
"SEFL",
"TNT_CLICK_IT",
"HDB",
"HIPSHIPPER",
"RPXLOGISTICS",
"KUEHNE",
"IT_NEXIVE",
"PTS",
"SWISS_POST_FTP",
"FASTRK_SERV",
"_4_72",
"US_YRC",
"POSTNL_INTL_3S",
"ELIAN_POST",
"CUBYN",
"SAU_SAUDI_POST",
"ABXEXPRESS_MY",
"HUAHAN_EXPRESS",
"ZES_EXPRESS",
"ZEPTO_EXPRESS",
"SKYNET_ZA",
"ZEEK_2_DOOR",
"BLINKLASTMILE",
"POSTA_UKR",
"CHROBINSON",
"CN_POST56",
"COURANT_PLUS",
"SCUDEX_EXPRESS",
"SHIPENTEGRA",
"B_TWO_C_EUROPE",
"COPE",
"IND_GATI",
"CN_WISHPOST",
"NACEX_ES",
"TAQBIN_HK",
"GLOBALTRANZ",
"HKD",
"BJSHOMEDELIVERY",
"OMNIVA",
"SUTTON",
"PANTHER_REFERENCE",
"SFCSERVICE",
"LTL",
"PARKNPARCEL",
"SPRING_GDS",
"ECEXPRESS",
"INTERPARCEL_AU",
"AGILITY",
"XL_EXPRESS",
"ADERONLINE",
"DIRECTCOURIERS",
"PLANZER",
"SENDING",
"NINJAVAN_WB",
"NATIONWIDE_MY",
"SENDIT",
"GB_ARROW",
"IND_GOJAVAS",
"KPOST",
"DHL_FREIGHT",
"BLUECARE",
"JINDOUYUN",
"TRACKON",
"GB_TUFFNELLS",
"TRUMPCARD",
"ETOTAL",
"SFPLUS_WEBHOOK",
"SEKOLOGISTICS",
"HERMES_2MANN_HANDLING",
"DPD_LOCAL_REF",
"UDS",
"ZA_SPECIALISED_FREIGHT",
"THA_KERRY",
"PRT_INT_SEUR",
"BRA_CORREIOS",
"NZ_NZ_POST",
"CN_EQUICK",
"MYS_EMS",
"GB_NORSK",
"ESP_MRW",
"ESP_PACKLINK",
"KANGAROO_MY",
"RPX",
"XDP_UK_REFERENCE",
"NINJAVAN_MY",
"ADICIONAL",
"ROADBULL",
"YAKIT",
"MAILAMERICAS",
"MIKROPAKKET",
"DYNALOGIC",
"DHL_ES",
"DHL_PARCEL_NL",
"DHL_GLOBAL_MAIL_ASIA",
"DAWN_WING",
"GENIKI_GR",
"HERMESWORLD_UK",
"ALPHAFAST",
"BUYLOGIC",
"EKART",
"MEX_SENDA",
"SFC_LOGISTICS",
"POST_SERBIA",
"IND_DELHIVERY",
"DE_DPD_DELISTRACK",
"RPD2MAN",
"CN_SF_EXPRESS",
"YANWEN",
"MYS_SKYNET",
"CORREOS_DE_MEXICO",
"CBL_LOGISTICA",
"MEX_ESTAFETA",
"AU_AUSTRIAN_POST",
"RINCOS",
"NLD_DHL",
"RUSSIAN_POST",
"COURIERS_PLEASE",
"POSTNORD_LOGISTICS",
"FEDEX",
"DPE_EXPRESS",
"DPD",
"ADSONE",
"IDN_JNE",
"THECOURIERGUY",
"CNEXPS",
"PRT_CHRONOPOST",
"LANDMARK_GLOBAL",
"IT_DHL_ECOMMERCE",
"ESP_NACEX",
"PRT_CTT",
"BE_KIALA",
"ASENDIA_UK",
"GLOBAL_TNT",
"POSTUR_IS",
"EPARCEL_KR",
"INPOST_PACZKOMATY",
"IT_POSTE_ITALIA",
"BE_BPOST",
"PL_POCZTA_POLSKA",
"MYS_MYS_POST",
"SG_SG_POST",
"THA_THAILAND_POST",
"LEXSHIP",
"FASTWAY_NZ",
"DHL_AU",
"COSTMETICSNOW",
"PFLOGISTICS",
"LOOMIS_EXPRESS",
"GLS_ITALY",
"LINE",
"GEL_EXPRESS",
"HUODULL",
"NINJAVAN_SG",
"JANIO",
"AO_COURIER",
"BRT_IT_SENDER_REF",
"SAILPOST",
"LALAMOVE",
"NEWZEALAND_COURIERS",
"ETOMARS",
"VIRTRANSPORT",
"WIZMO",
"PALLETWAYS",
"I_DIKA",
"CFL_LOGISTICS",
"GEMWORLDWIDE",
"GLOBAL_EXPRESS",
"LOGISTYX_TRANSGROUP",
"WESTBANK_COURIER",
"ARCO_SPEDIZIONI",
"YDH_EXPRESS",
"PARCELINKLOGISTICS",
"CNDEXPRESS",
"NOX_NIGHT_TIME_EXPRESS",
"AERONET",
"LTIANEXP",
"INTEGRA2_FTP",
"PARCELONE",
"NOX_NACHTEXPRESS",
"CN_CHINA_POST_EMS",
"CHUKOU1",
"GLS_SLOV",
"ORANGE_DS",
"JOOM_LOGIS",
"AUS_STARTRACK",
"DHL",
"GB_APC",
"BONDSCOURIERS",
"JPN_JAPAN_POST",
"USPS",
"WINIT",
"ARG_OCA",
"TW_TAIWAN_POST",
"DMM_NETWORK",
"TNT",
"BH_POSTA",
"SWE_POSTNORD",
"CA_CANADA_POST",
"WISELOADS",
"ASENDIA_HK",
"NLD_GLS",
"MEX_REDPACK",
"JET_SHIP",
"DE_DHL_EXPRESS",
"NINJAVAN_THAI",
"RABEN_GROUP",
"ESP_ASM",
"HRV_HRVATSKA",
"GLOBAL_ESTES",
"LTU_LIETUVOS",
"BEL_DHL",
"AU_AU_POST",
"SPEEDEXCOURIER",
"FR_COLIS",
"ARAMEX",
"DPEX",
"MYS_AIRPAK",
"CUCKOOEXPRESS",
"DPD_POLAND",
"NLD_POSTNL",
"NIM_EXPRESS",
"QUANTIUM",
"SENDLE",
"ESP_REDUR",
"MATKAHUOLTO",
"CPACKET",
"POSTI",
"HUNTER_EXPRESS",
"CHOIR_EXP",
"LEGION_EXPRESS",
"AUSTRIAN_POST_EXPRESS",
"GRUPO",
"POSTA_RO",
"INTERPARCEL_UK",
"GLOBAL_ABF",
"POSTEN_NORGE",
"XPERT_DELIVERY",
"DHL_REFR",
"DHL_HK",
"SKYNET_UAE",
"GOJEK",
"YODEL_INTNL",
"JANCO",
"YTO",
"WISE_EXPRESS",
"JTEXPRESS_VN",
"FEDEX_INTL_MLSERV",
"VAMOX",
"AMS_GRP",
"DHL_JP",
"HRPARCEL",
"GESWL",
"BLUESTAR",
"CDEK_TR",
"DESCARTES",
"DELTEC_UK",
"DTDC_EXPRESS",
"TOURLINE",
"BH_WORLDWIDE",
"OCS",
"YINGNUO_LOGISTICS",
"UPS",
"TOLL",
"PRT_SEUR",
"DTDC_AU",
"THA_DYNAMIC_LOGISTICS",
"UBI_LOGISTICS",
"FEDEX_CROSSBORDER",
"A1POST",
"TAZMANIAN_FREIGHT",
"CJ_INT_MY",
"SAIA_FREIGHT",
"SG_QXPRESS",
"NHANS_SOLUTIONS",
"DPD_FR",
"COORDINADORA",
"ANDREANI",
"DOORA",
"INTERPARCEL_NZ",
"PHL_JAMEXPRESS",
"BEL_BELGIUM_POST",
"US_APC",
"IDN_POS",
"FR_MONDIAL",
"DE_DHL",
"HK_RPX",
"DHL_PIECEID",
"VNPOST_EMS",
"RRDONNELLEY",
"DPD_DE",
"DELCART_IN",
"IMEXGLOBALSOLUTIONS",
"ACOMMERCE",
"EURODIS",
"CANPAR",
"GLS",
"IND_ECOM",
"ESP_ENVIALIA",
"DHL_UK",
"SMSA_EXPRESS",
"TNT_FR",
"DEX_I",
"BUDBEE_WEBHOOK",
"COPA_COURIER",
"VNM_VIETNAM_POST",
"DPD_HK",
"TOLL_NZ",
"ECHO",
"FEDEX_FR",
"BORDEREXPRESS",
"MAILPLUS_JPN",
"TNT_UK_REFR",
"KEC",
"DPD_RO",
"TNT_JP",
"TH_CJ",
"EC_CN",
"FASTWAY_UK",
"FASTWAY_US",
"GLS_DE",
"GLS_ES",
"GLS_FR",
"MONDIAL_BE",
"SGT_IT",
"TNT_CN",
"TNT_DE",
"TNT_ES",
"TNT_PL",
"PARCELFORCE",
"SWISS_POST",
"TOLL_IPEC",
"AIR_21",
"AIRSPEED",
"BERT",
"BLUEDART",
"COLLECTPLUS",
"COURIERPLUS",
"COURIER_POST",
"DHL_GLOBAL_MAIL",
"DPD_UK",
"DELTEC_DE",
"DEUTSCHE_DE",
"DOTZOT",
"ELTA_GR",
"EMS_CN",
"ECARGO",
"ENSENDA",
"FERCAM_IT",
"FASTWAY_ZA",
"FASTWAY_AU",
"FIRST_LOGISITCS",
"GEODIS",
"GLOBEGISTICS",
"GREYHOUND",
"JETSHIP_MY",
"LION_PARCEL",
"AEROFLASH",
"ONTRAC",
"SAGAWA",
"SIODEMKA",
"STARTRACK",
"TNT_AU",
"TNT_IT",
"TRANSMISSION",
"YAMATO",
"DHL_IT",
"DHL_AT",
"LOGISTICSWORLDWIDE_KR",
"GLS_SPAIN",
"AMAZON_UK_API",
"DPD_FR_REFERENCE",
"DHLPARCEL_UK",
"MEGASAVE",
"QUALITYPOST",
"IDS_LOGISTICS",
"JOYINGBOX",
"PANTHER_ORDER_NUMBER",
"WATKINS_SHEPARD",
"FASTTRACK",
"UP_EXPRESS",
"ELOGISTICA",
"ECOURIER",
"CJ_PHILIPPINES",
"SPEEDEX",
"ORANGECONNEX",
"TECOR",
"SAEE",
"GLS_ITALY_FTP",
"DELIVERE",
"YYCOM",
"ADICIONAL_PT",
"DKSH",
"NIPPON_EXPRESS_FTP",
"GOLS",
"FUJEXP",
"QTRACK",
"OMLOGISTICS_API",
"GDPHARM",
"MISUMI_CN",
"AIR_CANADA",
"CITY56_WEBHOOK",
"SAGAWA_API",
"KEDAEX",
"PGEON_API",
"WEWORLDEXPRESS",
"JT_LOGISTICS",
"TRUSK",
"VIAXPRESS",
"DHL_SUPPLYCHAIN_ID",
"ZUELLIGPHARMA_SFTP",
"MEEST",
"TOLL_PRIORITY",
"MOTHERSHIP_API",
"CAPITAL",
"EUROPAKET_API",
"HFD",
"TOURLINE_REFERENCE",
"GIO_ECOURIER",
"CN_LOGISTICS",
"PANDION",
"BPOST_API",
"PASSPORTSHIPPING",
"PAKAJO",
"DACHSER",
"YUSEN_SFTP",
"SHYPLITE",
"XYY",
"MWD",
"FAXECARGO",
"MAZET",
"FIRST_LOGISTICS_API",
"SPRINT_PACK",
"HERMES_DE_FTP",
"CONCISE",
"KERRY_EXPRESS_TW_API",
"EWE",
"FASTDESPATCH",
"ABCUSTOM_SFTP",
"CHAZKI",
"SHIPPIE",
"GEODIS_API",
"NAQEL_EXPRESS",
"PAPA_WEBHOOK",
"FORWARDAIR",
"DIALOGO_LOGISTICA_API",
"LALAMOVE_API",
"TOMYDOOR",
"KRONOS_WEBHOOK",
"JTCARGO",
"T_CAT",
"CONCISE_WEBHOOK",
"TELEPORT_WEBHOOK",
"CUSTOMCO_API",
"SPX_TH",
"BOLLORE_LOGISTICS",
"CLICKLINK_SFTP",
"M3LOGISTICS",
"VNPOST_API",
"AXLEHIRE_FTP",
"SHADOWFAX",
"MYHERMES_UK_API",
"DAIICHI",
"MENSAJEROSURBANOS_API",
"POLARSPEED",
"IDEXPRESS_ID",
"PAYO",
"WHISTL_SFTP",
"INTEX_DE",
"TRANS2U",
"PRODUCTCAREGROUP_SFTP",
"BIGSMART",
"EXPEDITORS_API_REF",
"AITWORLDWIDE_API",
"WORLDCOURIER",
"QUIQUP",
"AGEDISS_SFTP",
"ANDREANI_API",
"CRLEXPRESS",
"SMARTCAT",
"CROSSFLIGHT",
"PROCARRIER",
"DHL_REFERENCE_API",
"SEINO_API",
"WSPEXPRESS",
"KRONOS",
"TOTAL_EXPRESS_API",
"PARCLL",
"XPEDIGO",
"STAR_TRACK_WEBHOOK",
"GPOST",
"UCS",
"DMFGROUP",
"COORDINADORA_API",
"MARKEN",
"NTL",
"REDJEPAKKETJE",
"ALLIED_EXPRESS_FTP",
"MONDIALRELAY_ES",
"NAEKO_FTP",
"MHI",
"SHIPPIFY",
"MALCA_AMIT_API",
"JTEXPRESS_SG_API",
"DACHSER_WEB",
"FLIGHTLG",
"CAGO",
"COM1EXPRESS",
"TONAMI_FTP",
"PACKFLEET",
"PUROLATOR_INTERNATIONAL",
"WINESHIPPING_WEBHOOK",
"DHL_ES_SFTP",
"PCHOME_API",
"CESKAPOSTA_API",
"GORUSH",
"HOMERUNNER",
"AMAZON_ORDER",
"EFWNOW_API",
"CBL_LOGISTICA_API",
"NIMBUSPOST",
"LOGWIN_LOGISTICS",
"NOWLOG_API",
"DPD_NL",
"GODEPENDABLE",
"ESDEX",
"LOGISYSTEMS_SFTP",
"EXPEDITORS",
"SNTGLOBAL_API",
"SHIPX",
"QINTL_API",
"PACKS",
"POSTNL_INTERNATIONAL",
"AMAZON_EMAIL_PUSH",
"DHL_API",
"SPX",
"AXLEHIRE",
"ICSCOURIER",
"DIALOGO_LOGISTICA",
"SHUNBANG_EXPRESS",
"TCS_API",
"SF_EXPRESS_CN",
"PACKETA",
"SIC_TELIWAY",
"MONDIALRELAY_FR",
"INTIME_FTP",
"JD_EXPRESS",
"FASTBOX",
"PATHEON",
"INDIA_POST",
"TIPSA_REF",
"ECOFREIGHT",
"VOX",
"DIRECTFREIGHT_AU_REF",
"BESTTRANSPORT_SFTP",
"AUSTRALIA_POST_API",
"FRAGILEPAK_SFTP",
"FLIPXP",
"VALUE_WEBHOOK",
"DAESHIN",
"SHERPA",
"MWD_API",
"SMARTKARGO",
"DNJ_EXPRESS",
"GOPEOPLE",
"MYSENDLE_API",
"ARAMEX_API",
"PIDGE",
"THAIPARCELS",
"PANTHER_REFERENCE_API",
"POSTAPLUS",
"BUFFALO",
"U_ENVIOS",
"ELITE_CO",
"ROCHE_INTERNAL_SFTP",
"DBSCHENKER_ICELAND",
"TNT_FR_REFERENCE",
"NEWGISTICSAPI",
"GLOVO",
"GWLOGIS_API",
"SPREETAIL_API",
"MOOVA",
"PLYCONGROUP",
"USPS_WEBHOOK",
"REIMAGINEDELIVERY",
"EDF_FTP",
"DAO365",
"BIOCAIR_FTP",
"RANSA_WEBHOOK",
"SHIPXPRES",
"COURANT_PLUS_API",
"SHIPA",
"HOMELOGISTICS",
"DX",
"POSTE_ITALIANE_PACCOCELERE",
"TOLL_WEBHOOK",
"LCTBR_API",
"DX_FREIGHT",
"DHL_SFTP",
"SHIPROCKET",
"UBER_WEBHOOK",
"STATOVERNIGHT",
"BURD",
"FASTSHIP",
"IBVENTURE_WEBHOOK",
"GATI_KWE_API",
"CRYOPDP_FTP",
"HUBBED",
"TIPSA_API",
"ARASKARGO",
"THIJS_NL",
"ATSHEALTHCARE_REFERENCE",
"99MINUTOS",
"HELLENIC_POST",
"HSM_GLOBAL",
"MNX",
"NMTRANSFER",
"LOGYSTO",
"INDIA_POST_INT",
"AMAZON_FBA_SWISHIP_IN",
"SRT_TRANSPORT",
"BOMI",
"DELIVERR_SFTP",
"HSDEXPRESS",
"SIMPLETIRE_WEBHOOK",
"HUNTER_EXPRESS_SFTP",
"UPS_API",
"WOOYOUNG_LOGISTICS_SFTP",
"PHSE_API",
"WISH_EMAIL_PUSH",
"NORTHLINE",
"MEDAFRICA",
"DPD_AT_SFTP",
"ANTERAJA",
"DHL_GLOBAL_FORWARDING_API",
"LBCEXPRESS_API",
"SIMSGLOBAL",
"CDLDELIVERS",
"TYP",
"TESTING_COURIER_WEBHOOK",
"PANDAGO_API",
"ROYAL_MAIL_FTP",
"THUNDEREXPRESS",
"SECRETLAB_WEBHOOK",
"SETEL",
"JD_WORLDWIDE",
"DPD_RU_API",
"ARGENTS_WEBHOOK",
"POSTONE",
"TUSKLOGISTICS",
"RHENUS_UK_API",
"TAQBIN_SG_API",
"INNTRALOG_SFTP",
"DAYROSS",
"CORREOSEXPRESS_API",
"INTERNATIONAL_SEUR_API",
"YODEL_API",
"HEROEXPRESS",
"DHL_SUPPLYCHAIN_IN",
"URGENT_CARGUS",
"FRONTDOORCORP",
"JTEXPRESS_PH",
"PARCELSTARS_WEBHOOK",
"DPD_SK_SFTP",
"MOVIANTO",
"OZEPARTS_SHIPPING",
"KARGOMKOLAY",
"TRUNKRS",
"OMNIRPS_WEBHOOK",
"CHILEXPRESS",
"TESTING_COURIER",
"JNE_API",
"BJSHOMEDELIVERY_FTP",
"DEXPRESS_WEBHOOK",
"USPS_API",
"TRANSVIRTUAL",
"SOLISTICA_API",
"CHIENVENTURE_WEBHOOK",
"DPD_UK_SFTP",
"INPOST_UK",
"JAVIT",
"ZTO_DOMESTIC",
"DHL_GT_API",
"CEVA_TRACKING",
"KOMON_EXPRESS",
"EASTWESTCOURIER_FTP",
"DANNIAO",
"SPECTRAN",
"DELIVER_IT",
"RELAISCOLIS",
"GLS_SPAIN_API",
"POSTPLUS",
"AIRTERRA",
"GIO_ECOURIER_API",
"DPD_CH_SFTP",
"FEDEX_API",
"INTERSMARTTRANS",
"HERMES_UK_SFTP",
"EXELOT_FTP",
"DHL_PA_API",
"VIRTRANSPORT_SFTP",
"WORLDNET",
"INSTABOX_WEBHOOK",
"KNG",
"FLASHEXPRESS_WEBHOOK",
"MAGYAR_POSTA_API",
"WESHIP_API",
"OHI_WEBHOOK",
"MUDITA",
"BLUEDART_API",
"T_CAT_API",
"ADS",
"HERMES_IT",
"FITZMARK_API",
"POSTI_API",
"SMSA_EXPRESS_WEBHOOK",
"TAMERGROUP_WEBHOOK",
"LIVRAPIDE",
"NIPPON_EXPRESS",
"BETTERTRUCKS",
"FAN",
"PB_USPSFLATS_FTP",
"PARCELRIGHT",
"ITHINKLOGISTICS",
"KERRY_EXPRESS_TH_WEBHOOK",
"ECOUTIER",
"SHOWL",
"BRT_IT_API",
"RIXONHK_API",
"DBSCHENKER_API",
"ILYANGLOGIS",
"MAIL_BOX_ETC",
"WESHIP",
"DHL_GLOBAL_MAIL_API",
"ACTIVOS24_API",
"ATSHEALTHCARE",
"LUWJISTIK",
"GW_WORLD",
"FAIRSENDEN_API",
"SERVIP_WEBHOOK",
"SWISHIP",
"TANET",
"HOTSIN_CARGO",
"DIREX",
"HUANTONG",
"IMILE_API",
"AUEXPRESS",
"NYTLOGISTICS",
"DSV_REFERENCE",
"NOVOFARMA_WEBHOOK",
"AITWORLDWIDE_SFTP",
"SHOPOLIVE",
"FNF_ZA",
"DHL_ECOMMERCE_GC",
"FETCHR",
"STARLINKS_API",
"YYEXPRESS",
"SERVIENTREGA",
"HANJIN",
"SPANISH_SEUR_FTP",
"DX_B2B_CONNUM",
"HELTHJEM_API",
"INEXPOST",
"A2B_BA",
"RHENUS_GROUP",
"SBERLOGISTICS_RU",
"MALCA_AMIT",
"PPL",
"OSM_WORLDWIDE_SFTP",
"ACILOGISTIX",
"OPTIMACOURIER",
"NOVA_POSHTA_API",
"LOGGI",
"YIFAN",
"MYDYNALOGIC",
"MORNINGLOBAL",
"CONCISE_API",
"FXTRAN",
"DELIVERYOURPARCEL_ZA",
"UPARCEL",
"MOBI_BR",
"LOGINEXT_WEBHOOK",
"EMS",
"SPEEDY",
"ZOOM_RED",
"NAVLUNGO",
"CASTLEPARCELS",
"WEEE",
"PACKALY",
"YUNHUIPOST",
"YOUPARCEL",
"LEMAN",
"MOOVIN",
"URB_IT",
"MULTIENTREGAPANAMA",
"JUSDASR",
"DISCOUNTPOST",
"RHENUS_UK",
"SWISHIP_JP",
"GLS_US",
"SMTL",
"EMEGA",
"EXPRESSONE_SV",
"HEPSIJET",
"WELIVERY",
"BRINGER",
"EASYROUTES",
"MRW",
"RPM",
"DPD_PRT",
"GLS_ROMANIA",
"LMPARCEL",
"GTAGSM",
"DOMINO",
"ESHIPPER",
"TRANSPAK",
"XINDUS",
"AOYUE",
"EASYPARCEL",
"EXPRESSONE",
"SENDEO_KARGO",
"SPEEDAF",
"ETOWER",
"GCX",
"NINJAVAN_VN",
"ALLEGRO",
"JUMPPOINT",
"SHIPGLOBAL_US",
"KINISI",
"OAKH",
"AWEST",
"BARSAN",
"ENERGOLOGISTIC",
"MADROOEX",
"GOBOLT",
"SWISS_UNIVERSAL_EXPRESS",
"IORDIRECT",
"XMSZM",
"GLS_HUN",
"SENDY",
"BRAUNSEXPRESS",
"GRANDSLAMEXPRESS",
"XGS",
"OTSCHILE",
"PACK_UP",
"PARCELSTARS",
"TEAMEXPRESSLLC",
"ASYADEXPRESS",
"TDN",
"EARLYBIRD",
"CACESA",
"PARCELJET",
"MNG_KARGO",
"SUPERPACKLINE",
"SPEEDX",
"VESYL",
"SKYKING",
"DIRMENSAJERIA",
"NETLOGIXGROUP",
"ZYOU",
"JAWAR",
"AGSYSTEMS",
"GPS",
"PTT_KARGO",
"MAERGO",
"ARIHANTCOURIER",
"VTFE",
"YUNANT",
"URBIFY",
"PACK_MAN",
"LIEFERGRUN",
"OBIBOX",
"PAIKEDA",
"SCOTTY",
"INTELCOM_CA",
"SWE",
"ASENDIA",
"DPD_AT",
"RELAY",
"ATA",
"SKYEXPRESS_INTERNATIONAL",
"SURAT_KARGO",
"SGLINK",
"FLEETOPTICSINC",
"SHOPLINE",
"PIGGYSHIP",
"LOGOIX",
"KOLAY_GELSIN",
"ASSOCIATED_COURIERS",
"UPS_CHECKER",
"WINESHIPPING",
"SPEDISCI"
]
},
"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
}
}
},
"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": "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,
"maxLength": 255,
"pattern": "^[0-9A-Z_]+$",
"x-enumDescriptions": [
{
"value": "SHIPPING",
"description": "The payer intends to receive the items at a specified address.",
"default": true
},
{
"value": "PICKUP_IN_PERSON",
"description": "DEPRECATED. Please use \"PICKUP_FROM_PERSON\" instead."
},
{
"value": "PICKUP_IN_STORE",
"description": "The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, \"Buy Online, Pick-up in Store\". Seller protection is provided with this option."
},
{
"value": "PICKUP_FROM_PERSON",
"description": "The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, \"Buy Online, Pick-up in Person\". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment."
}
],
"enum": [
"SHIPPING",
"PICKUP_IN_PERSON",
"PICKUP_IN_STORE",
"PICKUP_FROM_PERSON"
]
},
"options": {
"$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:Note: If there are multiple purchase units, reference_id is required for each purchase unit.",
"minLength": 1,
"maxLength": 256,
"pattern": "^.*$"
},
"amount": {
"description": "The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.",
"$ref": "#/components/schemas/amount_with_breakdown"
},
"shipping_options": {
"$ref": "#/components/schemas/definitions-shipping_option_list"
}
}
},
"shipping_type": {
"type": "string",
"title": "Shipping Type",
"description": "A classification for the method of purchase fulfillment.",
"x-enumDescriptions": [
{
"value": "SHIPPING",
"description": "The payer intends to receive the items at a specified address.",
"default": true
},
{
"value": "PICKUP",
"description": "DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). "
},
{
"value": "PICKUP_IN_STORE",
"description": "The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, \"Buy Online, Pick-up in Store\". Seller protection is provided with this option."
},
{
"value": "PICKUP_FROM_PERSON",
"description": "The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, \"Buy Online, Pick-up in Person\". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment."
}
],
"enum": ["SHIPPING", "PICKUP", "PICKUP_IN_STORE", "PICKUP_FROM_PERSON"]
},
"shipping_with_tracking_details": {
"type": "object",
"title": "Shipping With Tracking Details",
"description": "The order shipping details.",
"allOf": [
{
"$ref": "#/components/schemas/shipping_detail"
},
{
"properties": {
"trackers": {
"$ref": "#/components/schemas/tracker_list"
}
}
}
]
},
"single_use_token": {
"type": "string",
"description": "The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.",
"minLength": 1,
"maxLength": 255,
"pattern": "^[0-9a-zA-Z_-]+$"
},
"sofort": {
"type": "object",
"title": "Sofort payment object",
"description": "Information used to pay using Sofort.",
"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"
},
"bic": {
"description": "The bank identification code (BIC).",
"$ref": "#/components/schemas/bic"
},
"iban_last_chars": {
"$ref": "#/components/schemas/iban_last_chars"
}
}
},
"sofort_request": {
"type": "object",
"title": "Sofort payment request",
"description": "Information needed to pay using Sofort.",
"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_base"
}
},
"required": ["name", "country_code"]
},
"store_in_vault_instruction": {
"type": "string",
"description": "Defines how and when the payment source gets vaulted.",
"minLength": 1,
"maxLength": 255,
"pattern": "^[0-9A-Z_]+$",
"x-enumDescriptions": [
{
"value": "ON_SUCCESS",
"description": "Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful."
}
],
"enum": ["ON_SUCCESS"]
},
"stored_payment_source": {
"type": "object",
"title": "Stored Payment Source",
"description": "Provides additional details to process a payment using a `payment_source` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.",
"properties": {
"brand_name": {
"type": "string",
"description": "The business name of the merchant. The pattern is defined by an external party and supports Unicode.",
"minLength": 1,
"maxLength": 127,
"pattern": "^.*$"
},
"shipping_preference": {
"type": "string",
"description": "The location from which the shipping address is derived.",
"minLength": 1,
"maxLength": 24,
"pattern": "^[A-Z_]+$",
"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"]
},
"order_update_callback_config": {
"description": "Merchant provided Order Update callback configuration for Venmo Wallet.Venmo will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when `shipping.type` is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.",
"$ref": "#/components/schemas/callback_configuration"
}
}
},
"venmo_wallet_request": {
"type": "object",
"title": "Venmo Wallet Request",
"description": "Information needed to pay using Venmo.",
"properties": {
"vault_id": {
"description": "The PayPal-generated ID for the saved Venmo wallet payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.",
"$ref": "#/components/schemas/vault_id"
},
"email_address": {
"description": "The email address of the payer.",
"$ref": "#/components/schemas/email"
},
"experience_context": {
"$ref": "#/components/schemas/venmo_wallet_experience_context"
},
"attributes": {
"description": "Additional attributes associated with the use of this wallet.",
"$ref": "#/components/schemas/venmo_wallet_attributes"
}
}
},
"venmo_wallet_response": {
"type": "object",
"title": "Venmo Wallet Response",
"description": "Venmo wallet response.",
"properties": {
"email_address": {
"description": "The email address of the payer.",
"$ref": "#/components/schemas/email"
},
"account_id": {
"description": "This is an immutable system-generated id for a user's Venmo account.",
"readOnly": true,
"$ref": "#/components/schemas/account_id-2"
},
"user_name": {
"description": "The Venmo user name chosen by the user, also know as a Venmo handle.",
"type": "string",
"pattern": "^[-a-zA-Z0-9_]*$",
"minLength": 1,
"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
}
}
},
"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:return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.