Note: In the live environment, merchants cannot create disputes but can only respond to customer-created disputes. However, merchants can create disputes in the sandbox environment. When you create an app, enable Disputes in the App feature options section.A customer can also ask his or her bank or credit card company to dispute and reverse a charge, which is known as a chargeback. For more information, see Disputes, claims, chargebacks, and bank reversals.
Important: The create, cancel, compute metrics, change reason, and validate eligibility methods are available as a limited-release solution at this time. For more information, reach out to your PayPal account manager.
dispute_id, reason, status,
dispute_state, dispute_life_cycle_stage,
dispute_channel, dispute_amount,
create_time and update_time
fields.page_size query
parameter.page_size=2start_time
instead of disputed_transaction_id200 OK status
code and a JSON response body that lists disputes with a full or
summary set of details. Default is a summary set of details, which
shows the dispute_id, reason,
status, dispute_amount,
create_time, and update_time fields for
each dispute.
content:
application/json:
schema:
$ref: "#/components/schemas/dispute_search"
"400":
description: The request failed due to a validation error. The request returns
the HTTP `400 Bad Request` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
default:
description: The error response.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
parameters:
- $ref: "#/components/parameters/start_time"
- $ref: "#/components/parameters/disputed_transaction_id"
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/page_size"
- $ref: "#/components/parameters/next_page_token"
- $ref: "#/components/parameters/dispute_state"
- $ref: "#/components/parameters/create_time_before"
- $ref: "#/components/parameters/create_time_after"
- $ref: "#/components/parameters/update_time_before"
- $ref: "#/components/parameters/update_time_after"
security:
- Oauth2:
- https://uri.paypal.com/services/disputes/read-buyer
- Oauth2:
- https://uri.paypal.com/services/disputes/read-seller
- Oauth2:
- https://uri.paypal.com/services/disputes/read-ebay
- Oauth2:
- https://uri.paypal.com/services/disputes/read
- Oauth2:
- https://uri.paypal.com/services/disputes/read-partner
tags:
- disputes
/v1/customer/disputes/{id}:
get:
summary: Show dispute details
description: Shows details for a dispute, by
ID.Note: The fields that appear in the response depend on the access. For example, if the merchant requests shows dispute details, the customer's email ID does not appear.operationId: disputes.get responses: "200": description: A successful request returns the HTTP `200 OK` status code and a JSON response body that shows dispute details. content: application/json: schema: $ref: "#/components/schemas/dispute" "500": description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code. content: application/json: schema: $ref: "#/components/schemas/error" default: description: The error response. content: application/json: schema: $ref: "#/components/schemas/error" parameters: - $ref: "#/components/parameters/id" security: - Oauth2: - https://uri.paypal.com/services/disputes/read-buyer - Oauth2: - https://uri.paypal.com/services/disputes/read-seller - Oauth2: - https://uri.paypal.com/services/disputes/read-ebay - Oauth2: - https://uri.paypal.com/services/disputes/read - Oauth2: - https://uri.paypal.com/services/disputes/read-partner tags: - disputes patch: summary: Partially update dispute description: Partially updates a dispute, by ID. Seller can update the `communication_detail` value or The partner can add the `partner action` information. operationId: disputes.patch responses: "202": description: A successfully accepted request returns the HTTP `202 Accepted` status code and a JSON response body that includes a [HATEOAS link](/docs/api/reference/api-responses/#hateoas-links) to the ID of the request. The Clients can choose webhook option as well to receive dispute update notification. content: application/json: schema: $ref: "#/components/schemas/subsequent_action" "204": description: A successful request returns the HTTP `204 No Content` status code with no JSON response body. "400": description: The request failed due to a validation error. The request returns the HTTP `400 Bad Request` status code. content: application/json: schema: $ref: "#/components/schemas/error" "422": description: The requested action could not be completed. The request returns the HTTP `422 Unprocessable Entity` status code. content: application/json: schema: $ref: "#/components/schemas/error" "500": description: An internal server error occurred. The request returns the HTTP `500 Internal Server Error` status code. content: application/json: schema: $ref: "#/components/schemas/error" default: description: The error response. content: application/json: schema: $ref: "#/components/schemas/error" parameters: - $ref: "#/components/parameters/id" - $ref: "#/components/parameters/content_type" requestBody: content: application/json: schema: $ref: "#/components/schemas/patch_request" multipart/related: schema: $ref: "#/components/schemas/patch_request" multipart/form-data: schema: $ref: "#/components/schemas/patch_request" multipart/mixed: schema: $ref: "#/components/schemas/patch_request" security: - Oauth2: - https://uri.paypal.com/services/disputes/update-seller tags: - disputes /v1/customer/disputes/{id}/provide-evidence: post: summary: Provide evidence description: Provides evidence for a dispute, by ID. A merchant can provide evidence for disputes with the
WAITING_FOR_SELLER_RESPONSE
status while customers can provide evidence for disputes with the
WAITING_FOR_BUYER_RESPONSE status. Evidence can be a proof
of delivery or proof of refund document or notes, which can include
logs. A proof of delivery document includes a tracking number while a
proof of refund document includes a refund ID. For other evidence type,
notes and documents can be given. Evidences requested from you can be
found by checking the type of evidence for the corresponding source
under the evidence section of the show dispute
details response. The source will be
REQUESTED_FROM_SELLER for evidences requested from the
merchant while it will be REQUESTED_FROM_BUYER for
evidences requested from the customer. For constraints and rules
regarding documents, see documents.provide-evidence link in the HATEOAS
links of the show dispute
details response. In case the link is not present in the response,
you can't provide evidence for the dispute. For information about
dispute reasons, see dispute
reasons.
operationId: disputes.provide-evidence
responses:
"200":
description: A successful request returns the HTTP `200 OK` status code and a
JSON response body that includes a link to the dispute.
content:
application/json:
schema:
$ref: "#/components/schemas/subsequent_action"
"400":
description: The request failed due to a validation error. The request returns
the HTTP `400 Bad Request` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
default:
description: The error response.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/content_type"
requestBody:
$ref: "#/components/requestBodies/evidences"
security:
- Oauth2:
- https://uri.paypal.com/services/disputes/update-seller
- Oauth2:
- https://uri.paypal.com/services/disputes/update-buyer
- Oauth2:
- https://uri.paypal.com/services/disputes/update-partner
tags:
- disputes-actions
/v1/customer/disputes/{id}/appeal:
post:
summary: Appeal dispute
description: Appeals a dispute, by ID. To appeal a dispute, use the
appeal link in the HATEOAS
links from the show dispute details response. If this link does not
appear, you cannot appeal the dispute. Submit new evidence as a document
or notes in the JSON request body. For constraints and rules regarding
documents, see documents.Important: This method is for sandbox use only.Settles a dispute in either the customer's or merchant's favor. Merchants can make this call in the sandbox to complete end-to-end dispute resolution testing, which mimics the dispute resolution that PayPal agents normally complete. To make this call, the dispute
status must be UNDER_REVIEW and
adjudicate link should be available in the HATEOAS
links of the show dispute
details response.
operationId: disputes.adjudicate
responses:
"200":
description: A successful request returns the HTTP `200 OK` status code and a
JSON response body that includes a link to the dispute.
content:
application/json:
schema:
$ref: "#/components/schemas/subsequent_action"
"400":
description: The request failed due to a validation error. The request returns
the HTTP `400 Bad Request` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"422":
description: The requested action could not be completed. The request returns
the HTTP `422 Unprocessable Entity` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"500":
description: An internal server error occurred. The request returns the HTTP
`500 Internal Server Error` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
default:
description: The error response.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/content_type"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/adjudicate"
multipart/related:
schema:
$ref: "#/components/schemas/adjudicate"
multipart/form-data:
schema:
$ref: "#/components/schemas/adjudicate"
multipart/mixed:
schema:
$ref: "#/components/schemas/adjudicate"
security:
- Oauth2:
- https://uri.paypal.com/services/disputes/update-seller
- Oauth2:
- https://uri.paypal.com/services/disputes/update-buyer
tags:
- disputes-actions
/v1/customer/disputes/{id}/require-evidence:
post:
summary: Update dispute status
description: Important: This method is for sandbox use only.Updates the status of a dispute, by ID, from
UNDER_REVIEW to
either:WAITING_FOR_BUYER_RESPONSEWAITING_FOR_SELLER_RESPONSEstatus must
be UNDER_REVIEW and require-evidence
link should be available in the HATEOAS
links of the show dispute
details response. Specify an action value in the JSON
request body to indicate whether the status change enables the customer
or merchant to submit evidence:If
action is | The status updates
to |
|---|---|
BUYER_EVIDENCE |
WAITING_FOR_BUYER_RESPONSE |
SELLER_EVIDENCE |
WAITING_FOR_SELLER_RESPONSE |
send-message link in the HATEOAS
links of the show dispute
details response and specify the message in the JSON request body.
In case the link is not present in the response you can't send a message
on the dispute.
operationId: disputes.send-message
responses:
"200":
description: A successful request returns the HTTP `200 OK` status code and a
JSON response body that includes a link to the dispute.
content:
application/json:
schema:
$ref: "#/components/schemas/subsequent_action"
"400":
description: The request failed due to a validation error. The request returns
the HTTP `400 Bad Request` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"422":
description: The requested action could not be completed. The request returns
the HTTP `422 Unprocessable Entity` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"500":
description: An internal server error occurred. The request returns the HTTP
`500 Internal Server Error` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
default:
description: The error response.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/content_type"
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
message_document:
description: A file that contains any additional info about the message posted.
type: string
contentMediaType: application/octet-stream
security:
- Oauth2:
- https://uri.paypal.com/services/disputes/update-seller
- Oauth2:
- https://uri.paypal.com/services/disputes/update-buyer
tags:
- disputes-actions
/v1/customer/disputes/{id}/make-offer:
post:
summary: Make offer to resolve dispute
description: Makes an offer to the other party to resolve a dispute, by ID. To
make this call, the stage in the dispute lifecycle must be `INQUIRY`. If
the customer accepts the offer, PayPal automatically makes a refund.
Allowed offer_type values for the request is available in dispute
details allowed
response options object.
operationId: disputes.make-offer
responses:
"200":
description: A successful request returns the HTTP `200 OK` status code and a
JSON response body that includes a link to the dispute.
content:
application/json:
schema:
$ref: "#/components/schemas/subsequent_action"
"400":
description: The request failed due to a validation error. The request returns
the HTTP `400 Bad Request` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"422":
description: The requested action could not be completed. The request returns
the HTTP `422 Unprocessable Entity` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"500":
description: An internal server error occurred. The request returns the HTTP
`500 Internal Server Error` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
default:
description: The error response.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/content_type"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/make_offer"
multipart/related:
schema:
$ref: "#/components/schemas/make_offer"
multipart/form-data:
schema:
$ref: "#/components/schemas/make_offer"
multipart/mixed:
schema:
$ref: "#/components/schemas/make_offer"
security:
- Oauth2:
- https://uri.paypal.com/services/disputes/update-seller
- Oauth2:
- https://uri.paypal.com/services/disputes/update-buyer
tags:
- disputes-actions
/v1/customer/disputes/{id}/accept-offer:
post:
summary: Accept offer to resolve dispute
description: The customer accepts the offer from merchant to resolve a dispute,
by ID. PayPal automatically refunds the amount proposed by merchant to
the customer.
operationId: disputes.accept-offer
responses:
"200":
description: A successful request returns the HTTP `200 OK` status code and a
JSON response body that includes a link to the dispute.
content:
application/json:
schema:
$ref: "#/components/schemas/subsequent_action"
"202":
description: A successfully accepted request returns the HTTP `202 Accepted`
status code and a JSON response body that includes a [HATEOAS
link](/docs/api/reference/api-responses/#hateoas-links) to the ID of
the request. The request returns `202 Accepted` status in case money
movement for the offer is delayed due to some internal reasons.
content:
application/json:
schema:
$ref: "#/components/schemas/subsequent_action"
"400":
description: The request failed due to a validation error. The request returns
the HTTP `400 Bad Request` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"422":
description: The requested action could not be completed. The request returns
the HTTP `422 Unprocessable Entity` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"500":
description: An internal server error occurred. The request returns the HTTP
`500 Internal Server Error` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
default:
description: The error response.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/content_type"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/accept_offer"
multipart/related:
schema:
$ref: "#/components/schemas/accept_offer"
multipart/form-data:
schema:
$ref: "#/components/schemas/accept_offer"
multipart/mixed:
schema:
$ref: "#/components/schemas/accept_offer"
security:
- Oauth2:
- https://uri.paypal.com/services/disputes/update-buyer
tags:
- disputes-actions
/v1/customer/disputes/{id}/deny-offer:
post:
summary: Deny offer to resolve dispute
description: Denies an offer that the merchant proposes for a dispute, by ID.
operationId: disputes.deny-offer
responses:
"200":
description: A successful request returns the HTTP `200 OK` status code and a
JSON response body that includes a link to the dispute.
content:
application/json:
schema:
$ref: "#/components/schemas/subsequent_action"
"400":
description: The request failed due to a validation error. The request returns
the HTTP `400 Bad Request` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"422":
description: The requested action could not be completed. The request returns
the HTTP `422 Unprocessable Entity` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"500":
description: An internal server error occurred. The request returns the HTTP
`500 Internal Server Error` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
default:
description: The error response.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/content_type"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/deny_offer"
multipart/related:
schema:
$ref: "#/components/schemas/deny_offer"
multipart/form-data:
schema:
$ref: "#/components/schemas/deny_offer"
multipart/mixed:
schema:
$ref: "#/components/schemas/deny_offer"
security:
- Oauth2:
- https://uri.paypal.com/services/disputes/update-buyer
tags:
- disputes-actions
/v1/customer/disputes/{id}/acknowledge-return-item:
post:
summary: Acknowledge returned item
description: Acknowledges that the customer returned an item for a dispute, by
ID. A merchant can make this request for disputes with the
`MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED` reason. Allowed
acknowledgement_type values for the request is available in dispute
details allowed
response options object. For constraints and rules regarding
documents, see documents.
operationId: disputes.acknowledge-return-item
responses:
"200":
description: A successful request returns the HTTP `200 OK` status code and a
JSON response body that includes a link to the dispute.
content:
application/json:
schema:
$ref: "#/components/schemas/subsequent_action"
"400":
description: The request failed due to a validation error. The request returns
the HTTP `400 Bad Request` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"422":
description: The requested action could not be completed. The request returns
the HTTP `422 Unprocessable Entity` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
"500":
description: An internal server error occurred. The request returns the HTTP
`500 Internal Server Error` status code.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
default:
description: The error response.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/content_type"
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
acknowledgement_document:
description: A file with evidence.
type: string
contentMediaType: application/octet-stream
security:
- Oauth2:
- https://uri.paypal.com/services/disputes/update-seller
tags:
- disputes-actions
/v1/customer/disputes/{id}/provide-supporting-info:
post:
summary: Provide supporting information for dispute
description: Provides supporting information for a dispute, by ID. A merchant or
buyer can make this request for disputes if they find the
`provide-supporting-info` link in the HATEOAS links in the list disputes
response. The party can provide the supporting information to PayPal to
defend themselves only when the `dispute_life_cycle_stage` is
`CHARGEBACK`, `PRE_ARBITRATION`, or `ARBITRATION`. They can provide a
note that describes their part with details or upload any supporting
documents to support their side. For constraints and rules regarding
documents, see documents.refund_amount and
return_shipping_address parameters from the accept
claim call.
- type: string
enum:
- REFUND_WITH_RETURN
description: The customer must return the item to the merchant and then merchant
will refund the money. This type is applicable when a merchant is
willing to refund the dispute amount and requires the customer to
return the item. Include the return_shipping_address
parameter in but omit the refund_amount parameter from
the accept
claim call.
- type: string
enum:
- PARTIAL_REFUND
description: The merchant proposes a partial refund for the dispute.This type is
applicable when a merchant is willing to refund an amount lesser
than dispute amount. Include the refund_amount
parameter.
- type: string
enum:
- REFUND_WITH_RETURN_SHIPMENT_LABEL
description: The customer must return the item to the merchant and then merchant
will refund the money. This type is applicable when a merchant is
willing to refund the dispute amount and requires the customer to
return the item using the shipment label provided by the merchant.
Include the return_shipment_info and
return_shipping_address parameter in but omit the
refund_amount parameter from the accept
claim call.
accept_claim_type_list:
type: array
description: The types of refund the merchant can provide the customer.
minItems: 1
maxItems: 10
items:
$ref: "#/components/schemas/accept_claim_type"
accept_offer:
type: object
title: Accept Offer Request
description: A customer request to accept the offer made by the merchant.
properties:
note:
type: string
minLength: 1
maxLength: 2000
pattern: ^(.|\r?\n)*$
description: The customer notes about accepting of offer. PayPal can but the
merchant cannot view these notes.
acknowledge_return_item_response_options:
type: object
title: Acknowledge Return Item Response Options
description: The allowed response options when the seller acknowledges that the
buyer has returned an item for the dispute.
properties:
acknowledgement_types:
$ref: "#/components/schemas/acknowledgement_type_list"
acknowledgement_type:
type: string
title: Allowed Acknowledgement Type
description: The type of acknowledgement allowed for the merchant after the
customer has returned the item. The merchant can update whether the item
was received and is as expected or if the item was not received.
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
readOnly: true
enum:
- ITEM_RECEIVED
- ITEM_NOT_RECEIVED
- DAMAGED
- EMPTY_PACKAGE_OR_DIFFERENT
- MISSING_ITEMS
oneOf:
- type: string
enum:
- ITEM_RECEIVED
description: The merchant has received the item returned by the customer.
- type: string
enum:
- ITEM_NOT_RECEIVED
description: The merchant has not received the item.
- type: string
enum:
- DAMAGED
description: The items returned by the customer were damaged.
- type: string
enum:
- EMPTY_PACKAGE_OR_DIFFERENT
description: The package was empty or the goods were different from what was
expected.
- type: string
enum:
- MISSING_ITEMS
description: The package did not have all the items that were expected.
acknowledgement_type_list:
type: array
description: The types of response when the merchant acknowledges a returned item.
minItems: 1
maxItems: 10
items:
$ref: "#/components/schemas/acknowledgement_type"
action_info:
type: object
title: Evidence Extensions
description: The extended properties for a evidence. Includes additional
information such as the action for which the evidence was
requested/submitted, and whether the evidence is mandatory.
properties:
action:
type: string
minLength: 1
maxLength: 255
pattern: ^[A-Z_]+$
description: The action for which the evidence was requested or submitted.
enum:
- ACKNOWLEDGE_RETURN_ITEM
- ACCEPT_CLAIM
- PROVIDE_EVIDENCE
- APPEAL
- CANCEL
- CHANGE_REASON
- ESCALATE
oneOf:
- type: string
enum:
- ACKNOWLEDGE_RETURN_ITEM
description: The evidence corresponds to action `acknowledge_return_item`.
- type: string
enum:
- ACCEPT_CLAIM
description: The evidence corresponds to action `accept_claim`.
- type: string
enum:
- PROVIDE_EVIDENCE
description: The evidence corresponds to action `provide_evidence`.
- type: string
enum:
- APPEAL
description: The evidence corresponds to action `appeal`.
- type: string
enum:
- CANCEL
description: The evidence corresponds to action `cancel`.
- type: string
enum:
- CHANGE_REASON
description: The evidence corresponds to action `change_reason`.
- type: string
enum:
- ESCALATE
description: The evidence corresponds to action `escalate`.
response_option:
type: string
minLength: 1
maxLength: 255
pattern: ^[A-Z_]+$
description: The response option for the corresponding action. Possible
values:.
mandatory:
type: boolean
description: Indicates whether the evidence is mandatory for the corresponding
action and response option.
additionalItems:
type: object
title: Additional Items
description: Any additional items.
address_details:
type: object
title: Address Details
description: The non-portable additional address details that are sometimes
needed for compliance, risk, or other scenarios where fine-grain address
information might be needed. Not portable with common third party and
open source. Redundant with core fields.Craven House.
maxLength: 100
sub_building:
type: string
description: The first-order entity below a named building or location that
represents the sub-premises. Usually a single building within a
collection of buildings with a common name. Can be a flat, story,
floor, room, or apartment.
maxLength: 100
address_portable:
type: object
title: Portable Postal Address (Medium-Grained)
description: "The portable international postal address. Maps to
[AddressValidationMetadata](https://github.com/googlei18n/libaddressinp\
ut/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)."
properties:
address_line_1:
type: string
description: The first line of the address. For example, number or street. For
example, `173 Drury Lane`. Required for data entry and compliance
and risk checks. Must contain the full address.
maxLength: 300
address_line_2:
type: string
description: The second line of the address. For example, suite or apartment
number.
maxLength: 300
address_line_3:
type: string
description: The third line of the address, if needed. For example, a street
complement for Brazil, direction text, such as `next to Walmart`, or
a landmark in an Indian address.
maxLength: 100
admin_area_4:
type: string
description: The neighborhood, ward, or district. Smaller than
`admin_area_level_3` or `sub_locality`. Value is:RESOLVED_BUYER_FAVOR.
- type: string
enum:
- SELLER_FAVOR
description: Resolves the case in the merchant's favor. Outcome is set to
RESOLVED_SELLER_FAVOR.
required:
- adjudication_outcome
adjudication:
type: object
title: Adjudication
description: The Adjudication details for the dispute.
properties:
type:
description: The type of adjudication.
$ref: "#/components/schemas/adjudication_type"
adjudication_time:
description: The date and time when the adjudication was done, in [Internet date
and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
$ref: "#/components/schemas/date_time"
reason:
description: The reason for the adjudication type.
$ref: "#/components/schemas/adjudication_reason"
dispute_life_cycle_stage:
description: The dispute life cycle stage during the adjudication.
$ref: "#/components/schemas/dispute_lifecycle_stage"
required:
- type
- adjudication_time
adjudication_list:
type: array
minItems: 1
maxItems: 10
description: The Teammate Adjudication details for the dispute.
items:
$ref: "#/components/schemas/adjudication"
adjudication_reason:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
description: The reason for the adjudication type.
enum:
- AMOUNT_DIFFERENCE_EXPECTED_DUE_TO_FEES
- BILLING_AGREEMENT_CHANGE_DISCLOSED
- BILLING_AGREEMENT_CHANGE_NOT_DISCLOSED
- BILLING_AGREEMENT_DATE_CHANGE_DISCLOSED
- BILLING_AGREEMENT_DATE_CHANGE_NOT_DISCLOSED
- BUYER_ATTEMPTED_RETURN
- BUYER_BILLED_ONLY_ONCE
- BUYER_CANCELLED_CASE
- BUYER_CANCELLED_SERVICE
- BUYER_FAILED_TO_DESCRIBE_ISSUE
- BUYER_HAS_POSSESSION_OF_THE_MERCHANDISE_OR_SERVICE
- BUYER_MADE_NO_ATTEMPT_TO_RESOLVE_WITH_SELLER
- BUYER_NOT_IN_POSSESSION_OF_ITEM_TO_RETURN
- BUYER_PROVIDED_CREDIT_RECEIPT
- BUYER_RECEIVED_DUPLICATE_REFUND
- CANCELLED_PER_TERMS_OF_BILLING_AGREEMENT
- CARD_NOT_STOLEN
- CARD_NOT_STOLEN_BEFORE_AUTH
- CUSTOMER_RECOGNIZES_TRANSACTION
- DECISION_BASED_ON_AVAILABLE_INFORMATION
- DELIVERY_AFTER_EXPECTED_DELIVERY_DATE
- DELIVERY_DUE_WITHIN_EXPECTED_DELIVERY_DATE
- DELIVERY_OR_SERVICE_REFUSED
- DOCUMENTATION_MATCHES_AMOUNT_CHARGED
- DOCUMENTATION_MATCHES_AMOUNT_IN_PAYPAL_ACCOUNT
- DUPLICATE_ADD_FUNDS
- EFFORTLESS_SELLER_PROTECTION
- IN_PERSON_DELIVERY
- INELIGIBLE_BUYER_PROTECTION_POLICY
- INELIGIBLE_SELLER_PROTECTION_POLICY
- INQUIRY_OFFER_ITEM_REPLACED
- INQUIRY_OFFER_PARTIAL_REFUND
- INQUIRY_OFFER_REFUND_WITH_ITEM_RETURN
- INQUIRY_OFFER_REFUND_WITH_REPLACEMENT
- INVALID_APPEAL_REASON
- INVALID_CHARGEBACK_SELLER_FAVOUR
- INVALID_DELIVERY_PROOF
- INVALID_DELIVERY_PROOF_SIGNATURE
- INVALID_DOCUMENTATION
- INVALID_PROOF_OF_SHIPMENT
- INVALID_REFUND_PROOF
- INVALID_RETURN_DELIVERY_NO_SIGNATURE_PROOF
- INVALID_RETURN_DELIVERY_PROOF
- INVALID_TRACKING
- ITEM_ALTERED_REPAIRED
- ITEM_NOT_AS_ADVERTISED
- ITEM_NOT_AS_DESCRIBED
- ITEM_NOT_DAMAGED
- ITEM_NOT_DELIVERED
- ITEM_NOT_RETURNED_TO_SELLER
- ITEM_NOT_SHIPPED
- ITEM_OF_DIFFERENT_QUALITY_OR_QUANTITY
- ITEM_OUT_OF_STOCK_AND_NOT_DELIVERED
- ITEM_RETURNED_TO_SELLER
- ITEM_SERVICE_MISREPRESENTED
- ITEM_SERVICE_NOT_MISREPRESENTED
- ITEM_SERVICE_RECEIVED_BY_BUYER
- ITEM_SOLD_AS_DESCRIBED
- ITEM_VALUE_UNAFFECTED
- MULTIPLE_APPEALS_WITH_SAME_REASON
- NO_DOCUMENTATION_FROM_BUYER
- NO_DOCUMENTATION_SUPPORTING_DUE_OF_CREDIT
- NO_PROOF_OF_DELIVERY
- NO_PROOF_OF_DELIVERY_INTANGIBLE
- NO_PROTECTION_FOR_DIGITAL_GOODS_SERVICE
- NO_RESPONSE_FROM_BUYER
- NO_RESPONSE_FROM_BUYER_FOR_ADDITIONAL_INFO_REQUEST
- NO_SELLER_RESPONSE
- NO_SELLER_RESPONSE_FOR_ADDITIONAL_INFO_REQUEST
- NO_VALID_SHIPMENT_PROOF
- NOT_A_BILLING_ERROR
- NOT_AN_UNAUTHORIZED_TRANSACTION
- NOT_DUPLICATE_FUNDS_ADDED_ONCE
- NOT_DUPLICATE_FUNDS_WITHDRAWN_ONCE
- NOT_SHIPPED_TO_CORRECT_ADDRESS
- PARTIAL_REFUND_ISSUED_FOR_MISSING_ITEMS
- PARTIAL_REFUND_OFFER_ACCEPTED
- PAYMENT_REVERSED_ALREADY
- POS_SUBMITTED_INSTEAD_OF_POD
- PREAUTH_INSTALLMENT_DUE
- PROOF_OF_BILLING_AFTER_CANCELLATION_ACCEPTED
- PROOF_OF_DUPLICATE_DENIED_OR_INSUFFICIENT
- PROOF_OF_INCORRECT_TRANSACTION_AMOUNT_ACCEPTED
- PROOF_OF_PAID_BY_OTHER_MEANS_NOT_SUBMITTED
- PROOF_OF_TRACKING_NOT_SUBMITTED
- PROTECTED_BY_PAYPAL
- REPRESENTED_BY_PAYPAL
- SELLER_ACCEPTED_MULTIPLE_PAYMENTS
- SELLER_AGREED_REFUND_WITHOUT_RETURN
- SELLER_AGREED_TO_ISSUE_CREDIT
- SELLER_ISSUED_CREDIT_TO_BUYER
- SELLER_ISSUED_REFUND
- SELLER_NOT_REACHABLE
- SELLER_RECEIVED_PAYMENT_TWICE_OR_FOR_REPLACEMENT
- SELLER_REFUSED_REFUND
- SELLER_REFUSED_RETURN
- SELLER_SURCHARGED_BUYER
- SERVICE_NOT_COMPLETED_AS_AGREED
- SHIPPING_COMPANY_WONT_SHIP
- TRACKING_PROOF_NOT_ENOUGH
- TRANSACTION_AUTHORIZED_BY_CARDHOLDER
- TRANSACTION_CANCELLED_AFTER_AUTHORIZATION_DATE
- TRANSACTION_CANCELLED_BEFORE_SHIPMENT_SERVICE_DATE
- TRANSACTION_MATCHES_BUYER_SPENDING_PATTERN
- TRANSACTION_PROCESSED_CORRECTLY
- TRUSTED_BUYER_PAYOUT
- UNUSED_SHIPPING_LABEL
- VALID_PROOF_OF_DELIVERY
- VALID_PROOF_OF_DELIVERY_WITH_SIGNATURE
- VALID_PROOF_OF_REFUND
- VALID_PROOF_SUPPORTING_CLAIM
- VALID_RETURN_DELIVERY_PROOF
- VALID_RETURN_DELIVERY_PROOF_WITH_SIGNATURE
- VALID_SHIPMENT_PROOF
- VALUE_AFFECTED_SIGNIFICANTLY
- PROTECTION_POLICY_APPLIES
- SNAD_DELAYED_FILING
- FUNDS_TRANSFERRED_TO_INCORRECT_RECIPIENT
- NO_SELLER_RESPONSE_FOR_ADDITIONAL_INFO_REQUEST
- IN_TRANSIT_BEYOND_TIMEFRAME_INVALID_PROOF_OF_SHIPMENT_OR_DELIVERY
- VALID_PROOF_SUPPORTING_CLAIM
- INVALID_EVIDENCE
- INVALID_PROOF_DELIVERED_TO_UNSPECIFIED_LOCATION
- INVALID_PROOF_DELIVERED_TO_INCORRECT_ADDRESS
- INVALID_PROOF_UNABLE_TO_TRACK
- SHIPPING_ADDRESS_NOT_PRESENT_IN_PROOF_OF_SHIPMENT_OR_DELIVERY
- INVALID_PROOF_ITEM_RETURNED_TO_SENDER
- DELIVERED_WITHOUT_REQUIRED_SIGNATURE_IN_PROOF_OF_DELIVERY
- NO_SHIPMENT_TRACKING_PROVIDED_IN_PROOF_OF_DELIVERY
- OTHER_ISSUE_WITH_PROOF_OF_SHIPMENT_OR_DELIVERY
- INSUFFICIENT_EVIDENCE_PROVIDED
- EVIDENCE_CANNOT_BE_LINKED_TO_TRANSACTION
- EVIDENCE_DOES_NOT_SHOW_FULFILLMENT_OR_CUSTOMER_BENEFIT
- SELLER_SHIPPED_OR_FULFILLED_BEYOND_ALLOWED_PERIOD
- ITEM_INELIGIBLE_FOR_SELLER_PROTECTION
- EVIDENCE_DOES_NOT_SHOW_SERVICE_COMPLETED
- VALID_RETURN_SHIPMENT_PROOF
- ITEM_EMPTY_BOX
- ITEM_UNUSABLE
- ITEM_MISSING_QUANTITY_OR_QUALITY
- REFUND_AMOUNT_MISMATCH
- DUPLICATE_PAYMENT
- SELLER_PROMISED_REFUND_NOT_ISSUED
- CUSTOMER_CHARGED_INCORRECT_AMOUNT
- DUPLICATE_PAYMENT_BY_OTHER_MEANS
- GOODWILL_PAYOUT
oneOf:
- type: string
enum:
- AMOUNT_DIFFERENCE_EXPECTED_DUE_TO_FEES
description: Seller submitted proof of correct charge.
- type: string
enum:
- BILLING_AGREEMENT_CHANGE_DISCLOSED
description: Seller had disclosed billing agreement changes upfront.
- type: string
enum:
- BILLING_AGREEMENT_CHANGE_NOT_DISCLOSED
description: Seller had not disclosed billing agreement changes upfront.
- type: string
enum:
- BILLING_AGREEMENT_DATE_CHANGE_DISCLOSED
description: Seller had shared change in billing agreement date upfront.
- type: string
enum:
- BILLING_AGREEMENT_DATE_CHANGE_NOT_DISCLOSED
description: Seller had not shared change in billing agreement date upfront.
- type: string
enum:
- BUYER_ATTEMPTED_RETURN
description: Buyer has attempted to return the item.
- type: string
enum:
- BUYER_BILLED_ONLY_ONCE
description: Buyer was charged only once and did not submit sufficient evidence
of duplicate charge.
- type: string
enum:
- BUYER_CANCELLED_CASE
description: Buyer cancelled the case.
- type: string
enum:
- BUYER_CANCELLED_SERVICE
description: Buyer cancelled the service or recurring transaction.
- type: string
enum:
- BUYER_FAILED_TO_DESCRIBE_ISSUE
description: Buyer did not describe the issue to justify the refund.
- type: string
enum:
- BUYER_HAS_POSSESSION_OF_THE_MERCHANDISE_OR_SERVICE
description: Buyer continues to possess the item or has received the service.
- type: string
enum:
- BUYER_MADE_NO_ATTEMPT_TO_RESOLVE_WITH_SELLER
description: Buyer did not attempt to resolve the issue with the seller.
- type: string
enum:
- BUYER_NOT_IN_POSSESSION_OF_ITEM_TO_RETURN
description: Buyer is not in possession of the item to be returned.
- type: string
enum:
- BUYER_PROVIDED_CREDIT_RECEIPT
description: Buyer provided credit receipt or relevant documentation.
- type: string
enum:
- BUYER_RECEIVED_DUPLICATE_REFUND
description: Buyer received the refund twice.
- type: string
enum:
- CANCELLED_PER_TERMS_OF_BILLING_AGREEMENT
description: Billing agreement was cancelled as per agreed terms.
- type: string
enum:
- CARD_NOT_STOLEN
description: Buyer in possession of the card which was reported as stolen or lost.
- type: string
enum:
- CARD_NOT_STOLEN_BEFORE_AUTH
description: Buyer reported card as lost or stolen after the authorization date.
- type: string
enum:
- CUSTOMER_RECOGNIZES_TRANSACTION
description: Buyer recognizes the transaction as valid.
- type: string
enum:
- DECISION_BASED_ON_AVAILABLE_INFORMATION
description: Case decision was made as per available information when specific
reasons are not applicable.
- type: string
enum:
- DELIVERY_AFTER_EXPECTED_DELIVERY_DATE
description: Item or service was delivered after the expected delivery date had
passed.
- type: string
enum:
- DELIVERY_DUE_WITHIN_EXPECTED_DELIVERY_DATE
description: Delivery of the item or service is due within the expected delivery
date.
- type: string
enum:
- DELIVERY_OR_SERVICE_REFUSED
description: Seller refused delivery or service of the item.
- type: string
enum:
- DOCUMENTATION_MATCHES_AMOUNT_CHARGED
description: Documentation provided supports the amount that was charged.
- type: string
enum:
- DOCUMENTATION_MATCHES_AMOUNT_IN_PAYPAL_ACCOUNT
description: Documentation provided supports the amount charged on buyer's
account.
- type: string
enum:
- DUPLICATE_ADD_FUNDS
description: Buyer submitted sufficient proof of duplicate charge.
- type: string
enum:
- EFFORTLESS_SELLER_PROTECTION
description: The case is decided based on Protection Policy.
- type: string
enum:
- IN_PERSON_DELIVERY
description: Seller delivered the item in person.
- type: string
enum:
- INELIGIBLE_BUYER_PROTECTION_POLICY
description: The pattern identified does not meet buyer protection eligibility.
- type: string
enum:
- INELIGIBLE_SELLER_PROTECTION_POLICY
description: The pattern identified does not meet seller protection eligibility.
- type: string
enum:
- INQUIRY_OFFER_ITEM_REPLACED
description: Seller agreed to replace the item.
- type: string
enum:
- INQUIRY_OFFER_PARTIAL_REFUND
description: Seller agreed to issue a partial refund to the buyer.
- type: string
enum:
- INQUIRY_OFFER_REFUND_WITH_ITEM_RETURN
description: Seller agreed to issue a refund for item return.
- type: string
enum:
- INQUIRY_OFFER_REFUND_WITH_REPLACEMENT
description: Seller agreed to replace the damaged item along with refunds
applicable.
- type: string
enum:
- INVALID_APPEAL_REASON
description: Seller appealed twice for the same reason with invalid reason.
- type: string
enum:
- INVALID_CHARGEBACK_SELLER_FAVOUR
description: The case is decided as invalid based on external network policy.
- type: string
enum:
- INVALID_DELIVERY_PROOF
description: Seller provided invalid proof of delivery.
- type: string
enum:
- INVALID_DELIVERY_PROOF_SIGNATURE
description: Buyer's signature confirmation missing in proof of delivery.
- type: string
enum:
- INVALID_DOCUMENTATION
description: The documentation provided is not valid.
- type: string
enum:
- INVALID_PROOF_OF_SHIPMENT
description: Seller provided invalid proof of shipment.
- type: string
enum:
- INVALID_REFUND_PROOF
description: Seller provided invalid proof of refund.
- type: string
enum:
- INVALID_RETURN_DELIVERY_NO_SIGNATURE_PROOF
description: Seller's signature confirmation missing in proof of return.
- type: string
enum:
- INVALID_RETURN_DELIVERY_PROOF
description: Buyer provided invalid proof of return.
- type: string
enum:
- INVALID_TRACKING
description: Seller provided invalid tracking information.
- type: string
enum:
- ITEM_ALTERED_REPAIRED
description: Item was altered or repaired while in buyer's possession.
- type: string
enum:
- ITEM_NOT_AS_ADVERTISED
description: Item or service provided didn’t match as it was advertised.
- type: string
enum:
- ITEM_NOT_AS_DESCRIBED
description: Item or service provided didn’t match as it was described.
- type: string
enum:
- ITEM_NOT_DAMAGED
description: Item or service provided was not damaged or missing any parts.
- type: string
enum:
- ITEM_NOT_DELIVERED
description: Seller did not deliver the item to the buyer.
- type: string
enum:
- ITEM_NOT_RETURNED_TO_SELLER
description: Item was not returned to seller.
- type: string
enum:
- ITEM_NOT_SHIPPED
description: Seller did not provide verified proof of shipment or delivery.
- type: string
enum:
- ITEM_OF_DIFFERENT_QUALITY_OR_QUANTITY
description: Item sent to the buyer was of different quality, quantity, color,
or size.
- type: string
enum:
- ITEM_OUT_OF_STOCK_AND_NOT_DELIVERED
description: Item was not delivered as it was no longer in stock.
- type: string
enum:
- ITEM_RETURNED_TO_SELLER
description: Buyer returned the item to seller.
- type: string
enum:
- ITEM_SERVICE_MISREPRESENTED
description: Seller's listing misrepresented the item.
- type: string
enum:
- ITEM_SERVICE_NOT_MISREPRESENTED
description: Seller's listing accurately represented the item.
- type: string
enum:
- ITEM_SERVICE_RECEIVED_BY_BUYER
description: Buyer received the item or service from the seller.
- type: string
enum:
- ITEM_SOLD_AS_DESCRIBED
description: Item was sold in the condition as described by the seller.
- type: string
enum:
- ITEM_VALUE_UNAFFECTED
description: Item value or usability was not affected significantly.
- type: string
enum:
- MULTIPLE_APPEALS_WITH_SAME_REASON
description: Seller appealed multiple times for the same reason without
providing any additional evidence.
- type: string
enum:
- NO_DOCUMENTATION_FROM_BUYER
description: No documentation received from buyer.
- type: string
enum:
- NO_DOCUMENTATION_SUPPORTING_DUE_OF_CREDIT
description: No documentation given to support that credit is due to buyer.
- type: string
enum:
- NO_PROOF_OF_DELIVERY
description: Seller did not provide proof of delivery.
- type: string
enum:
- NO_PROOF_OF_DELIVERY_INTANGIBLE
description: Seller did not provide proof of fulfillment for a service or
digital good.
- type: string
enum:
- NO_PROTECTION_FOR_DIGITAL_GOODS_SERVICE
description: Digital goods, services, or other Intangibles not covered under
Protection Policies.
- type: string
enum:
- NO_RESPONSE_FROM_BUYER
description: No response from buyer.
- type: string
enum:
- NO_RESPONSE_FROM_BUYER_FOR_ADDITIONAL_INFO_REQUEST
description: No response from buyer to the request for additional information.
- type: string
enum:
- NO_SELLER_RESPONSE
description: No response from seller.
- type: string
enum:
- NO_SELLER_RESPONSE_FOR_ADDITIONAL_INFO_REQUEST
description: Seller did not respond to a request for additional information.
- type: string
enum:
- NO_VALID_SHIPMENT_PROOF
description: Seller did not provide valid proof of shipment.
- type: string
enum:
- NOT_A_BILLING_ERROR
description: No evidence of a billing error.
- type: string
enum:
- NOT_AN_UNAUTHORIZED_TRANSACTION
description: No evidence of unauthorized account access was found.
- type: string
enum:
- NOT_DUPLICATE_FUNDS_ADDED_ONCE
description: Funds only added once and no duplication.
- type: string
enum:
- NOT_DUPLICATE_FUNDS_WITHDRAWN_ONCE
description: Funds only withdrawn once and no duplication.
- type: string
enum:
- NOT_SHIPPED_TO_CORRECT_ADDRESS
description: Seller did not ship to correct address.
- type: string
enum:
- PARTIAL_REFUND_ISSUED_FOR_MISSING_ITEMS
description: Seller issued refund for missing items.
- type: string
enum:
- PARTIAL_REFUND_OFFER_ACCEPTED
description: Buyer accepted the partial refund offer.
- type: string
enum:
- PAYMENT_REVERSED_ALREADY
description: Payment was previously refunded or reversed.
- type: string
enum:
- POS_SUBMITTED_INSTEAD_OF_POD
description: Seller submitted proof of shipment instead of proof of delivery.
- type: string
enum:
- PREAUTH_INSTALLMENT_DUE
description: Pre-authorized installment or balance is due to seller.
- type: string
enum:
- PROOF_OF_BILLING_AFTER_CANCELLATION_ACCEPTED
description: Buyer submitted proof of being billed after the billing agreement
was cancelled.
- type: string
enum:
- PROOF_OF_DUPLICATE_DENIED_OR_INSUFFICIENT
description: Buyer submitted proof that this was paid by another payment method.
- type: string
enum:
- PROOF_OF_INCORRECT_TRANSACTION_AMOUNT_ACCEPTED
description: Bank or Credit does not match withdrawal amount on PayPal.
- type: string
enum:
- PROOF_OF_PAID_BY_OTHER_MEANS_NOT_SUBMITTED
description: Buyer did not provide sufficient proof of paying by other means.
- type: string
enum:
- PROOF_OF_TRACKING_NOT_SUBMITTED
description: Buyer did not provide sufficient proof of tracking for returns.
- type: string
enum:
- PROTECTED_BY_PAYPAL
description: This case is covered under Seller protection program.
- type: string
enum:
- REPRESENTED_BY_PAYPAL
description: Paypal covered the cost of the case as decided by policy.
- type: string
enum:
- SELLER_ACCEPTED_MULTIPLE_PAYMENTS
description: Seller received multiple payments for the same purchase.
- type: string
enum:
- SELLER_AGREED_REFUND_WITHOUT_RETURN
description: Seller chose to issue a refund without requiring item to be returned.
- type: string
enum:
- SELLER_AGREED_TO_ISSUE_CREDIT
description: Seller agreed to refund the buyer.
- type: string
enum:
- SELLER_ISSUED_CREDIT_TO_BUYER
description: Seller has earlier issued a credit to the buyer for the same
transaction.
- type: string
enum:
- SELLER_ISSUED_REFUND
description: Seller has issued a refund.
- type: string
enum:
- SELLER_NOT_REACHABLE
description: Seller could not be reached to resolve case.
- type: string
enum:
- SELLER_RECEIVED_PAYMENT_TWICE_OR_FOR_REPLACEMENT
description: Seller received the payment twice or received payment for a
replacement item.
- type: string
enum:
- SELLER_REFUSED_REFUND
description: Seller declined to issue a refund.
- type: string
enum:
- SELLER_REFUSED_RETURN
description: Seller declined to accept return of the item.
- type: string
enum:
- SELLER_SURCHARGED_BUYER
description: Surcharge was assessed to the buyer.
- type: string
enum:
- SERVICE_NOT_COMPLETED_AS_AGREED
description: Service was not completed by seller as per description in the
agreement.
- type: string
enum:
- SHIPPING_COMPANY_WONT_SHIP
description: Shipping company refused to ship the item.
- type: string
enum:
- TRACKING_PROOF_NOT_ENOUGH
description: For an item which was significantly not as described, seller cannot
appeal with tracking information.
- type: string
enum:
- TRANSACTION_AUTHORIZED_BY_CARDHOLDER
description: Card holder authorized the use of card for the transaction.
- type: string
enum:
- TRANSACTION_CANCELLED_AFTER_AUTHORIZATION_DATE
description: Transaction was cancelled after the authorization date.
- type: string
enum:
- TRANSACTION_CANCELLED_BEFORE_SHIPMENT_SERVICE_DATE
description: Transaction was cancelled before the shipment or service date.
- type: string
enum:
- TRANSACTION_MATCHES_BUYER_SPENDING_PATTERN
description: Transaction similar to recent spending patterns of buyer.
- type: string
enum:
- TRANSACTION_PROCESSED_CORRECTLY
description: Transaction processed correctly.
- type: string
enum:
- TRUSTED_BUYER_PAYOUT
description: Payout to the buyer decided based on their profile and policy.
- type: string
enum:
- UNUSED_SHIPPING_LABEL
description: Shipping label provided was unused.
- type: string
enum:
- VALID_PROOF_OF_DELIVERY
description: Seller provided valid proof of delivery.
- type: string
enum:
- VALID_PROOF_OF_DELIVERY_WITH_SIGNATURE
description: Seller provided valid proof of delivery with signature confirmation.
- type: string
enum:
- VALID_PROOF_OF_REFUND
description: Seller provided valid proof of refund.
- type: string
enum:
- VALID_PROOF_SUPPORTING_CLAIM
description: Valid proof was provided by buyer that supports the claim.
- type: string
enum:
- VALID_RETURN_DELIVERY_PROOF
description: Buyer provided valid proof of return delivery.
- type: string
enum:
- VALID_RETURN_DELIVERY_PROOF_WITH_SIGNATURE
description: Buyer provided valid proof of return delivery with signature
confirmation.
- type: string
enum:
- VALID_SHIPMENT_PROOF
description: Seller provided valid proof of shipment.
- type: string
enum:
- VALUE_AFFECTED_SIGNIFICANTLY
description: The value of item or usability was affected significantly.
- type: string
enum:
- PROTECTION_POLICY_APPLIES
description: The case is decided based on Protection Policy.
- type: string
enum:
- SNAD_DELAYED_FILING
description: The reason as to why the buyer is filing dispute after given
specified days.
- type: string
enum:
- FUNDS_TRANSFERRED_TO_INCORRECT_RECIPIENT
description: Funds were not transferred to the correct recipient.
- type: string
enum:
- NO_SELLER_RESPONSE_FOR_ADDITIONAL_INFO_REQUEST
description: Seller did not respond to a request for additional information.
- type: string
enum:
- IN_TRANSIT_BEYOND_TIMEFRAME_INVALID_PROOF_OF_SHIPMENT_OR_DELIVERY
description: Seller provided invalid proof of shipment, delivery shows the item
was in transit beyond the allowed timeframe.
- type: string
enum:
- VALID_PROOF_SUPPORTING_CLAIM
description: Valid proof was provided by buyer that supports the claim.
- type: string
enum:
- INVALID_EVIDENCE
description: Seller provided invalid evidence, categorized as `OTHER`.
- type: string
enum:
- INVALID_PROOF_DELIVERED_TO_UNSPECIFIED_LOCATION
description: Seller provided invalid proof of shipment, delivery shows the item
was delivered to an unspecified location.
- type: string
enum:
- INVALID_PROOF_DELIVERED_TO_INCORRECT_ADDRESS
description: Seller provided invalid proof of shipment, delivery shows the item
was delivered to an incorrect address.
- type: string
enum:
- INVALID_PROOF_UNABLE_TO_TRACK
description: Seller provided invalid proof of shipment. The shipment could not
be tracked with the information provided.
- type: string
enum:
- SHIPPING_ADDRESS_NOT_PRESENT_IN_PROOF_OF_SHIPMENT_OR_DELIVERY
description: Seller provided invalid proof of shipment since it lacks the
correct shipping address.
- type: string
enum:
- INVALID_PROOF_ITEM_RETURNED_TO_SENDER
description: Seller provided invalid proof of shipment which shows the item was
returned back to the sender.
- type: string
enum:
- DELIVERED_WITHOUT_REQUIRED_SIGNATURE_IN_PROOF_OF_DELIVERY
description: Proof of delivery provided by the seller is invalid since it is
missing the required signature.
- type: string
enum:
- NO_SHIPMENT_TRACKING_PROVIDED_IN_PROOF_OF_DELIVERY
description: Proof of delivery provided by the seller is invalid since since no
shipment tracking is provided.
- type: string
enum:
- OTHER_ISSUE_WITH_PROOF_OF_SHIPMENT_OR_DELIVERY
description: Seller provided invalid proof of shipment or delivery.
- type: string
enum:
- INSUFFICIENT_EVIDENCE_PROVIDED
description: Seller did not provide any sufficient evidence.
- type: string
enum:
- EVIDENCE_CANNOT_BE_LINKED_TO_TRANSACTION
description: Evidence provided by the seller is invalid since it could not be
linked to the transaction.
- type: string
enum:
- EVIDENCE_DOES_NOT_SHOW_FULFILLMENT_OR_CUSTOMER_BENEFIT
description: Evidence provided by the seller does not demonstrate fulfillment or
customer benefit.
- type: string
enum:
- SELLER_SHIPPED_OR_FULFILLED_BEYOND_ALLOWED_PERIOD
description: Order was shipped two days after the dispute was filed, making the
evidence invalid.
- type: string
enum:
- ITEM_INELIGIBLE_FOR_SELLER_PROTECTION
description: Item does not meet the requirements for seller protection.
- type: string
enum:
- EVIDENCE_DOES_NOT_SHOW_SERVICE_COMPLETED
description: The evidence provided by the seller does not show that the service
was completed as per the service agreement.
- type: string
enum:
- VALID_RETURN_SHIPMENT_PROOF
description: Buyer provided evidence that the item was shipped back for return.
- type: string
enum:
- ITEM_EMPTY_BOX
description: The item sent to the buyer was an empty box.
- type: string
enum:
- ITEM_UNUSABLE
description: The item sent to the buyer was unusable.
- type: string
enum:
- ITEM_MISSING_QUANTITY_OR_QUALITY
description: The item sent to the buyer was missing in quality or quantity.
- type: string
enum:
- REFUND_AMOUNT_MISMATCH
description: The refund amount promised does not match the actual refunded amount.
- type: string
enum:
- DUPLICATE_PAYMENT
description: Multiple payments were processed for the same transaction.
- type: string
enum:
- SELLER_PROMISED_REFUND_NOT_ISSUED
description: The evidence indicates seller promised refund to the buyer but did
not issue it.
- type: string
enum:
- CUSTOMER_CHARGED_INCORRECT_AMOUNT
description: The evidence indicates customer was charged an incorrect amount.
- type: string
enum:
- DUPLICATE_PAYMENT_BY_OTHER_MEANS
description: The evidence indicates that the customer was charged multiple times
for the same order through different payment methods.
- type: string
enum:
- GOODWILL_PAYOUT
description: Seller did not provide enough evidence. Since the account is in
good standing, it will not be debited for the disputed amount this
time. The seller has been advised to review the previous adjudication
under adjudications
returned as part of the dispute
details API response for a detailed explanation of why the
evidence did not meet requirements.
adjudication_type:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
description: The type of adjudication.
enum:
- DENY_BUYER
- PAYOUT_TO_BUYER
- PAYOUT_TO_SELLER
- RECOVER_FROM_SELLER
oneOf:
- type: string
enum:
- DENY_BUYER
description: The decision is to deny the buyer for the dispute.
- type: string
enum:
- PAYOUT_TO_BUYER
description: The decision is to payout to the buyer.
- type: string
enum:
- PAYOUT_TO_SELLER
description: The decision is to payout to the seller if the seller was debited
earlier.
- type: string
enum:
- RECOVER_FROM_SELLER
description: The decision is to charge the seller for the dispute if the seller
was not debited already.
agreed_refund_details:
type: object
title: Agreed Refund Details
description: Details of Agreed Refund between customer and merchant.
properties:
merchant_agreed_refund:
type: boolean
description: Indicates whether merchant has agreed to refund the buyer or not.
merchant_agreed_refund_time:
description: The date and time proposed by merchant to provide the refund, in
[Internet date and time
format](https://tools.ietf.org/html/rfc3339#section-5.6).
$ref: "#/components/schemas/date_time"
allOf:
type: object
title: All Of Item
description: A sub-schema against which the data must validate.
allOf_list:
type: array
description: An array of sub-schemas. The data must validate against all sub-schemas.
items:
$ref: "#/components/schemas/allOf"
allowed_response_options:
type: object
title: Allowed Response Options
description: The allowed response options for the buyer/seller update actions.
properties:
acknowledge_return_item:
$ref: "#/components/schemas/acknowledge_return_item_response_options"
accept_claim:
$ref: "#/components/schemas/accept_claim_response_options"
make_offer:
$ref: "#/components/schemas/make_offer_response_options"
anyOf:
type: object
title: Any Of Item
description: A sub-schema against which the data must validate.
anyOf_list:
type: array
description: An array of sub-schemas. The data must validate against one or more
sub-schemas.
items:
$ref: "#/components/schemas/anyOf"
billing_disputes_properties:
type: object
title: Billing Disputes Properties
description: The billing issue details.
properties:
duplicate_transaction:
$ref: "#/components/schemas/duplicate_transaction"
incorrect_transaction_amount:
$ref: "#/components/schemas/incorrect_transaction_amount"
payment_by_other_means:
$ref: "#/components/schemas/payment_by_other_means"
credit_not_processed:
$ref: "#/components/schemas/credit_not_processed"
canceled_recurring_billing:
$ref: "#/components/schemas/canceled_recurring_billing"
buyer:
type: object
title: Customer
description: The details for the customer who funds the payment. For example,
the customer's first name, last name, and email address.
properties:
name:
type: string
minLength: 1
maxLength: 2000
pattern: ^[^~!@#$%^*()_{}:|\t\n/]+$
description: The customer's name.
buyer_escalation_reason: {}
canceled_recurring_billing:
type: object
title: Canceled Recurring Billing
description: The recurring billing canceled details.
properties:
expected_refund:
$ref: "#/components/schemas/money"
cancellation_details:
$ref: "#/components/schemas/cancellation_details"
cancellation_details:
type: object
title: Cancellation Details
description: The cancellation details.
properties:
cancellation_date:
description: The date and time of the cancellation, in [Internet date and time
format](http://tools.ietf.org/html/rfc3339#section-5.6).
$ref: "#/components/schemas/date_time"
cancellation_number:
description: The cancellation number.
type: string
minLength: 1
maxLength: 127
pattern: ^.*$
cancelled:
type: boolean
description: Indicates whether the dispute was canceled.
cancellation_mode:
description: Indicates the mode used for order cancellation.
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
enum:
- CANCELLED_PAYPAL_BILLING_AGREEMENT
- WEBSITE
- PHONE
- EMAIL
- WRITTEN
- IN_PERSON
oneOf:
- type: string
enum:
- CANCELLED_PAYPAL_BILLING_AGREEMENT
description: Cancelled the billing agreement.
- type: string
enum:
- WEBSITE
description: The item was cancelled on the merchant's website.
- type: string
enum:
- PHONE
description: The item was cancelled through either phone or fax.
- type: string
enum:
- EMAIL
description: The item was cancelled through either email or text message.
- type: string
enum:
- WRITTEN
description: The item was cancelled via written communication.
- type: string
enum:
- IN_PERSON
description: The item was cancelled in person.
communication_details:
type: object
title: Contact Details
description: The contact details that a merchant provides to the customer to use
to share their evidence documents.
properties:
email:
description: The email address that is provided by the merchant where the
customer can share the evidences.
$ref: "#/components/schemas/email_address"
note:
type: string
minLength: 1
maxLength: 2000
pattern: ^(.|\r?\n)*$
description: The merchant provided notes that are visible to both the customer
and PayPal.
time_posted:
description: The date and time when the contact details were posted, in
[Internet date and time
format](https://tools.ietf.org/html/rfc3339#section-5.6).
readOnly: true
$ref: "#/components/schemas/date_time"
country_code:
type: string
description: The [two-character ISO 3166-1
code](/api/rest/reference/country-codes/) that identifies the country or
region.Note: The country code for Great Britain isformat: ppaas_common_country_code_v2 maxLength: 2 minLength: 2 pattern: ^([A-Z]{2}|C2)$ credit_not_processed: type: object title: Credit Not Processed description: The credit not processed details. properties: issue_type: type: string minLength: 1 maxLength: 255 pattern: ^[0-9A-Z_]+$ description: The issue type. enum: - PRODUCT - SERVICE oneOf: - type: string enum: - PRODUCT description: The product has an issue. - type: string enum: - SERVICE description: The service has an issue. expected_refund: $ref: "#/components/schemas/money" cancellation_details: $ref: "#/components/schemas/cancellation_details" product_details: $ref: "#/components/schemas/product_details" service_details: $ref: "#/components/schemas/service_details" agreed_refund_details: $ref: "#/components/schemas/agreed_refund_details" cryptocurrency: type: object title: Cryptocurrency description: The details needed to represent a specific cryptocurrency balance, such as its symbol and quantity. properties: asset_symbol: $ref: "#/components/schemas/cryptocurrency_symbol" quantity: $ref: "#/components/schemas/cryptocurrency_quantity" quantity_in_subunits: $ref: "#/components/schemas/cryptocurrency_subunits_quantity" decimals: $ref: "#/components/schemas/cryptocurrency_decimals" required: - asset_symbol - quantity cryptocurrency_decimals: description: The number of decimal digits supported by this cryptocurrency. For example, for Bitcoin this value is 8 because there are 10^8 satoshis in one Bitcoin and for Ethereum it's 18 since there are 10^18 wei in one Ether. title: Decimals type: integer minimum: 0 maximum: 40 cryptocurrency_quantity: type: string minLength: 1 maxLength: 40 pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ description: The quantity of a cryptocurrency asset. This is a decimal number with a scale defined for each cryptocurrency by its founders. For example, Bitcoin (BTC) has 8 as its scale, Ethereum (ETH) has 18 as its scale. The PayPal Cryptocurrency platform handles the scale to 8 digits for Bitcoin. including its forks or offshoots, as well as Ethereum. cryptocurrency_subunits_quantity: title: Cryptocurrency Quantity Subunits type: string minLength: 1 maxLength: 81 pattern: ^-?[0-9]+$ description: "The quantity of a cryptocurrency asset in the currency's sub units.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})$ definitions-document_list: type: array minItems: 1 maxItems: 100 description: An array of evidence documents. items: $ref: "#/components/schemas/document" definitions-link_description_list: type: array description: An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). readOnly: true items: $ref: "#/components/schemas/link_description" definitions-sub_reasons: description: The sub-reason for the service issue. type: string minLength: 1 maxLength: 255 pattern: ^[0-9A-Z_]+$ enum: - DAMAGED - DIFFERENT - INCOMPLETE - OTHER oneOf: - type: string enum: - DAMAGED description: The service was damaged. - type: string enum: - DIFFERENT description: The service was different from what was expected. - type: string enum: - INCOMPLETE description: The service was incomplete. - type: string enum: - OTHER description: Other. definitions-sub_reasons_list: description: An array of sub-reasons for the service issue. type: array minItems: 1 maxItems: 10 items: $ref: "#/components/schemas/definitions-sub_reasons" deny_offer: type: object title: Deny Offer Request description: A customer request to deny the offer made by the merchant. properties: note: type: string minLength: 1 maxLength: 2000 pattern: ^(.|\r?\n)*$ description: The customer notes about the denial of offer. PayPal can but the merchant cannot view these notes. required: - note dependencies: type: object title: Dependencies description: Any Dependencies. dispute: type: object title: Dispute Details description: The dispute details. properties: dispute_id: type: string minLength: 1 maxLength: 255 pattern: ^[A-Za-z0-9-]+$ readOnly: true description: The ID of the dispute. create_time: readOnly: true description: The date and time when the dispute was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`. $ref: "#/components/schemas/date_time" update_time: readOnly: true description: The date and time when the dispute was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`. $ref: "#/components/schemas/date_time" disputed_transactions: $ref: "#/components/schemas/transaction_info_list" reason: $ref: "#/components/schemas/dispute_reason" status: readOnly: true $ref: "#/components/schemas/status" dispute_amount: description: The amount in the transaction that the customer originally disputed. Because customers can sometimes dispute only part of the payment, the disputed amount might be different from the total gross or net amount of the original transaction. $ref: "#/components/schemas/money" dispute_asset: description: The asset in the transaction that the customer disputed. $ref: "#/components/schemas/cryptocurrency" fee_policy: readOnly: true description: Policy that determines whether the fee needs to be charged, retained or returned while moving the money as part of dispute process. $ref: "#/components/schemas/fee_policy" external_reason_code: type: string minLength: 1 maxLength: 2000 pattern: ^[A-Za-z0-9._-]+$ description: The code that identifies the reason for the credit card chargeback. Each card issuer follows their own standards for defining reason type, code, and its format. For more details about the external reason code, see the card issue site. Available for only unbranded transactions. dispute_outcome: readOnly: true $ref: "#/components/schemas/dispute_outcome" adjudications: $ref: "#/components/schemas/adjudication_list" money_movements: $ref: "#/components/schemas/money_movement_list" fund_movements: $ref: "#/components/schemas/fund_movement_list" dispute_life_cycle_stage: readOnly: true $ref: "#/components/schemas/dispute_lifecycle_stage" dispute_channel: $ref: "#/components/schemas/dispute_channel" messages: $ref: "#/components/schemas/message_list" extensions: $ref: "#/components/schemas/extensions" evidences: $ref: "#/components/schemas/evidence_list" buyer_response_due_date: readOnly: true description: The date and time by when the customer must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the customer does not respond by this date and time, the dispute is closed in the merchant's favor. For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`. $ref: "#/components/schemas/date_time" seller_response_due_date: readOnly: true description: The date and time by when the merchant must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the merchant does not respond by this date and time, the dispute is closed in the customer's favor. For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`. $ref: "#/components/schemas/date_time" offer: readOnly: true $ref: "#/components/schemas/offer" refund_details: readOnly: true $ref: "#/components/schemas/refund_details" communication_details: $ref: "#/components/schemas/communication_details" supporting_info: $ref: "#/components/schemas/supporting_info_list" allowed_response_options: readOnly: true $ref: "#/components/schemas/allowed_response_options" links: $ref: "#/components/schemas/dispute_definitions-link_description_list" dispute_channel: readOnly: true type: string minLength: 1 maxLength: 255 pattern: ^[A-Z0-9_]+$ description: The channel where the customer created the dispute. enum: - INTERNAL - EXTERNAL - ALERT oneOf: - type: string enum: - INTERNAL description: The customer contacts PayPal to file a dispute with the merchant. - type: string enum: - EXTERNAL description: The customer contacts their card issuer or bank to request a refund. - type: string enum: - ALERT description: Pre-chargeback alert when customer contacts their card issuer to request a refund. dispute_definitions-link_description_list: type: array minItems: 1 maxItems: 10 description: An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/). readOnly: true items: $ref: "#/components/schemas/link_description" dispute_info: type: object title: Dispute Summary Information description: The dispute summary information. properties: dispute_id: type: string minLength: 1 maxLength: 255 pattern: ^[A-Za-z0-9-]+$ readOnly: true description: The ID of the dispute. create_time: readOnly: true description: The date and time when the dispute was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`. $ref: "#/components/schemas/date_time" update_time: readOnly: true description: The date and time when the dispute was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`. $ref: "#/components/schemas/date_time" reason: $ref: "#/components/schemas/dispute_reason" status: readOnly: true $ref: "#/components/schemas/status" dispute_state: readOnly: true $ref: "#/components/schemas/dispute_state" dispute_amount: description: The amount in the transaction that the customer originally disputed. Because customers can sometimes dispute only part of the payment, the disputed amount might be different from the total gross or net amount of the original transaction. $ref: "#/components/schemas/money" dispute_asset: description: The asset in the transaction that the customer disputed. $ref: "#/components/schemas/cryptocurrency" dispute_life_cycle_stage: readOnly: true $ref: "#/components/schemas/dispute_lifecycle_stage" dispute_channel: readOnly: true $ref: "#/components/schemas/dispute_channel" buyer_response_due_date: readOnly: true description: The date and time by when the customer must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the customer does not respond by this date and time, the dispute is closed in the merchant's favor. For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`. $ref: "#/components/schemas/date_time" seller_response_due_date: readOnly: true description: The date and time by when the merchant must respond to the dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). If the merchant does not respond by this date and time, the dispute is closed in the customer's favor. For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`. $ref: "#/components/schemas/date_time" links: $ref: "#/components/schemas/dispute_info_definitions-link_description_list" dispute_info_definitions-link_description_list: type: array minItems: 1 maxItems: 10 description: An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/). readOnly: true items: $ref: "#/components/schemas/link_description" dispute_info_list: type: array minItems: 1 maxItems: 100 description: An array of disputes that match the filter criteria. Sorted in latest to earliest creation time order. items: $ref: "#/components/schemas/dispute_info" dispute_lifecycle_stage: type: string minLength: 1 maxLength: 255 pattern: ^[0-9A-Z_]+$ readOnly: true description: The stage in the dispute lifecycle. enum: - INQUIRY - CHARGEBACK - PRE_ARBITRATION - ARBITRATION oneOf: - type: string enum: - INQUIRY description: A customer and merchant interact in an attempt to resolve a dispute without escalation to PayPal. Occurs when the customer:
INTERNAL. This
stage is a PayPal dispute lifecycle stage and not a credit card or
debit card chargeback. All notes that the customer sends in this
stage are visible to PayPal agents only. The customer must wait for
PayPal’s response before the customer can take further action. In
this stage, PayPal shares dispute details with the merchant, who can
complete one of these actions:Note: Document download may require some configuration setup and available as a limited release at this time. For more information, reach out to your PayPal account manager.. document_list: type: array readOnly: true description: An array of metadata for the documents which contains any additional info about the message posted. items: $ref: "#/components/schemas/document" minItems: 1 maxItems: 10 duplicate_transaction: type: object title: Duplicate Transaction description: The duplicate transaction details. properties: received_duplicate: type: boolean description: If `true`, indicates that a duplicate transaction was received. original_transaction: description: The transaction details for the original transaction, when the dispute reason is `DUPLICATE_TRANSACTION`. Currently, contains only the date and amount. $ref: "#/components/schemas/transaction_info" email_address: type: string description: The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after theformat: 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])+)\])$ error: type: object title: Error description: The error details. properties: name: type: string description: The human-readable, unique name of the error. message: type: string description: The message that describes the error. debug_id: type: string description: The PayPal internal ID. Used for correlation purposes. information_link: type: string description: The information link, or URI, that shows detailed information about this error for the developer. readOnly: true details: $ref: "#/components/schemas/error_details_list" links: $ref: "#/components/schemas/definitions-link_description_list" required: - name - message - debug_id 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" examples: - 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" examples: - 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_details-2: 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: type: string description: The location of the field that caused the error. Value is `body`, `path`, or `query`. default: body 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. links: $ref: "#/components/schemas/link_description_list" required: - issue error_details_list: type: array description: An array of additional details about the error. items: $ref: "#/components/schemas/error_details-2" 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 escalate: type: object title: Escalate Claim Request description: A merchant request to escalate a dispute, by ID, to a PayPal claim. properties: note: type: string minLength: 1 maxLength: 2000 pattern: ^(.|\r?\n)*$ description: The notes about the escalation of the dispute to a claim. buyer_escalation_reason: $ref: "#/components/schemas/buyer_escalation_reason" escalate_response: type: object title: Escalate Response description: The response for escalate action. properties: links: $ref: "#/components/schemas/escalate_response_definitions-link_description_list" escalate_response_definitions-link_description_list: type: array minItems: 1 maxItems: 10 description: An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/). readOnly: true items: $ref: "#/components/schemas/link_description" evidence: type: object title: Evidence description: A merchant- or customer-submitted evidence document. evidence_info is expected for PROOF_OF_FULFILLMENT,PROOF_OF_REFUND and PROOF_OF_RETURN evidence types. documents and notes can be given for rest of the evidence types. properties: evidence_type: $ref: "#/components/schemas/evidence_type" evidence_info: $ref: "#/components/schemas/evidence_info" documents: $ref: "#/components/schemas/definitions-document_list" notes: type: string description: Any evidence-related notes. minLength: 1 maxLength: 2000 pattern: ^(.|\r?\n)*$ source: type: string minLength: 1 maxLength: 255 pattern: ^[A-Z_]+$ readOnly: true description: The source of the evidence. enum: - REQUESTED_FROM_BUYER - REQUESTED_FROM_SELLER - SUBMITTED_BY_BUYER - SUBMITTED_BY_SELLER - SUBMITTED_BY_PARTNER oneOf: - type: string enum: - REQUESTED_FROM_BUYER description: PayPal requested evidence from the customer. - type: string enum: - REQUESTED_FROM_SELLER description: PayPal requested evidence from the merchant. - type: string enum: - SUBMITTED_BY_BUYER description: Evidence was submitted by the customer. - type: string enum: - SUBMITTED_BY_SELLER description: Evidence was submitted by the merchant. - type: string enum: - SUBMITTED_BY_PARTNER description: Evidence was submitted by the partner. date: readOnly: true description: The date and time when the evidence was received, in [Internet date and time format](http://tools.ietf.org/html/rfc3339#section-5.6). $ref: "#/components/schemas/date_time" item_id: type: string minLength: 1 maxLength: 255 pattern: ^[A-Za-z0-9]+$ description: The item ID. If the merchant provides multiple pieces of evidence and the transaction has multiple item IDs, the merchant can use this value to associate a piece of evidence with an item ID. item_type: readOnly: true description: The item type for which the evidence is requested or submitted. $ref: "#/components/schemas/item_type" action_info: readOnly: true description: The action details for the information. Includes additional information such as the action for which the evidence was requested/submitted, and whether the evidence is mandatory for the corresponding action. $ref: "#/components/schemas/action_info" dispute_life_cycle_stage: readOnly: true description: The dispute life cycle stage for the evidence. $ref: "#/components/schemas/dispute_lifecycle_stage" evidence_info: type: object title: Evidence Information description: The evidence-related information. properties: tracking_info: $ref: "#/components/schemas/tracking_info_list" refund_ids: $ref: "#/components/schemas/refund_ids_list" evidence_list: type: array minItems: 1 maxItems: 100 description: An array of evidence documents. items: $ref: "#/components/schemas/evidence" evidence_type: type: string minLength: 1 maxLength: 255 pattern: ^[A-Z0-9_]+$ description: The evidence type. enum: - PROOF_OF_FULFILLMENT - PROOF_OF_REFUND - PROOF_OF_DELIVERY_SIGNATURE - PROOF_OF_RECEIPT_COPY - RETURN_POLICY - BILLING_AGREEMENT - PROOF_OF_RESHIPMENT - ITEM_DESCRIPTION - POLICE_REPORT - AFFIDAVIT - PAID_WITH_OTHER_METHOD - COPY_OF_CONTRACT - TERMINAL_ATM_RECEIPT - PRICE_DIFFERENCE_REASON - SOURCE_CONVERSION_RATE - BANK_STATEMENT - CREDIT_DUE_REASON - REQUEST_CREDIT_RECEIPT - PROOF_OF_RETURN - CREATE - CHANGE_REASON - PROOF_OF_REFUND_OUTSIDE_PAYPAL - RECEIPT_OF_MERCHANDISE - CUSTOMS_DOCUMENT - CUSTOMS_FEE_RECEIPT - INFORMATION_ON_RESOLUTION - ADDITIONAL_INFORMATION_OF_ITEM - DETAILS_OF_PURCHASE - PROOF_OF_SIGNIFICANT_DIFFERENCE - PROOF_OF_SOFTWARE_OR_SERVICE_NOT_AS_DESCRIBED - PROOF_OF_CONFISCATION - PROOF_OF_DAMAGE - COPY_OF_LAW_ENFORCEMENT_AGENCY_REPORT - ADDITIONAL_PROOF_OF_SHIPMENT - PROOF_OF_DENIAL_BY_CARRIER - THIRDPARTY_PROOF_FOR_DAMAGE_OR_SIGNIFICANT_DIFFERENCE - VALID_SUPPORTING_DOCUMENT - LEGIBLE_SUPPORTING_DOCUMENT - RETURN_TRACKING_INFORMATION - DELIVERY_RECEIPT - PROOF_OF_INSTORE_RECEIPT - ADDITIONAL_TRACKING_INFORMATION - PROOF_OF_SHIPMENT_POSTAGE - ONLINE_TRACKING_INFORMATION - PROOF_OF_INSTORE_REFUND - PROOF_FOR_SOFTWARE_OR_SERVICE_DELIVERED - RETURN_ADDRESS_FOR_SHIPPING - COPY_OF_THE_EPARCEL_MANIFEST - COPY_OF_SHIPPING_MANIFEST - APPEAL_AFFIDAVIT - RECEIPT_OF_REPLACEMENT - COPY_OF_DRIVERS_LICENSE - ACCOUNT_CHANGE_INFORMATION - DELIVERY_ADDRESS - CONFIRMATION_OF_RESOLUTION - MERCHANT_RESPONSE - PERMISSION_DESCRIPTION - STATUS_OF_MERCHANDISE - LOST_CARD_DETAILS - LAST_VALID_TRANSACTION_DETAILS - ADDITIONAL_PROOF_OF_RETURN - DECLARATION - PROOF_OF_MISSING_ITEMS - PROOF_OF_EMPTY_PACKAGE_OR_DIFFERENT_ITEM - PROOF_OF_ITEM_NOT_RECEIVED - ORDER_DETAILS - LISTING_URL - SHIPPING_INSURANCE - BUYER_RESPONSE - PHOTOS_OF_SHIPPED_ITEM - OTHER - CANCELLATION_DETAILS - MERCHANT_CONTACT_DETAILS - ITEM_DETAILS - CORRECT_RECIPIENT_INFORMATION - EXPLANATION_OF_FUNDS_NOT_DELIVERED - CONFIRMATION_OF_RECALL - COMMUNICATION_WITH_THE_SENDER - PAYMENT_REASON - PROOF_OF_EXPECTED_DELIVERY_DATE - DELIVERY_DELAY_COMMUNICATION - ADDITIONAL_SCAM_DETAILS - REASON_FOR_LATE_OPENING - COMMUNICATION_WITH_THE_RECIPIENT - EFFORTS_TO_VERIFY_RECIPIENT oneOf: - type: string enum: - PROOF_OF_FULFILLMENT description: Proof of fulfillment should be a copy of the actual shipping label on the package that shows the destination address and the shipping company's stamp to verify the shipment date. - type: string enum: - PROOF_OF_REFUND description: Proof of refund issued to the buyer - type: string enum: - PROOF_OF_DELIVERY_SIGNATURE description: Proof of delivery signature. - type: string enum: - PROOF_OF_RECEIPT_COPY description: Copy of original receipt or invoice. - type: string enum: - RETURN_POLICY description: Copy of terms and conditions,contract or store return policy - type: string enum: - BILLING_AGREEMENT description: Copy of billing agreement. - type: string enum: - PROOF_OF_RESHIPMENT description: "Proof of reshipment should be a copy of the actual shipping label on the package that shows the destination address and the shipping company's stamp to verify the reshipment date. " - type: string enum: - ITEM_DESCRIPTION description: A copy of the original description of the item or service - type: string enum: - POLICE_REPORT description: Copy of the police report filed. - type: string enum: - AFFIDAVIT description: More information has to be provided about the claim using the affidavit. - type: string enum: - PAID_WITH_OTHER_METHOD description: Document showing item/service was paid by another payment method. - type: string enum: - COPY_OF_CONTRACT description: Copy of contract if applicable. - type: string enum: - TERMINAL_ATM_RECEIPT description: Copy of terminal/ATM receipt. - type: string enum: - PRICE_DIFFERENCE_REASON description: Explanation of what the price difference is related to (increased tip amount, shipping charges, taxes, etc). - type: string enum: - SOURCE_CONVERSION_RATE description: Source of expected conversion rate or fee. - type: string enum: - BANK_STATEMENT description: Bank/Credit statement showing withdrawal transaction. - type: string enum: - CREDIT_DUE_REASON description: The credit due reason. - type: string enum: - REQUEST_CREDIT_RECEIPT description: The request credit receipt. - type: string enum: - PROOF_OF_RETURN description: Proof of shipment or postage that shows you returned this item to your seller and should be a copy of the actual shipping label used. - type: string enum: - CREATE description: Additional evidence information during case creation. - type: string enum: - CHANGE_REASON description: The evidence related to the reason change. - type: string enum: - PROOF_OF_REFUND_OUTSIDE_PAYPAL description: Document should show that the seller issued a refund outside Paypal. - type: string enum: - RECEIPT_OF_MERCHANDISE description: Check with buyer if item Delivered (seller provided Proof of Shipping) - type: string enum: - CUSTOMS_DOCUMENT description: Document confirming that the item has been confiscated. - type: string enum: - CUSTOMS_FEE_RECEIPT description: Custom fees receipt paid by the buyer - type: string enum: - INFORMATION_ON_RESOLUTION description: Any resolution reached with the seller should be communicated to PayPal. - type: string enum: - ADDITIONAL_INFORMATION_OF_ITEM description: Any additional information of the item purchased. - type: string enum: - DETAILS_OF_PURCHASE description: Specific details of a purchase made under a particular transaction has to be given. - type: string enum: - PROOF_OF_SIGNIFICANT_DIFFERENCE description: More information required on how the item was damaged or was significantly different from the item advertised. - type: string enum: - PROOF_OF_SOFTWARE_OR_SERVICE_NOT_AS_DESCRIBED description: Any screenshot or download/usage log showing that the software or service was unavailable or non-functional. - type: string enum: - PROOF_OF_CONFISCATION description: Documentation from a third party or organization that evaluated this item that confirms they confiscated it. - type: string enum: - PROOF_OF_DAMAGE description: Documentation supporting the claim that the item is damaged. - type: string enum: - COPY_OF_LAW_ENFORCEMENT_AGENCY_REPORT description: Report filed with a law enforcement agency or government organization. Examples of such agencies are - Internet Crime Complaint Center (www.ic3.gov), state Consumer Protection office, state police or a Federal law enforcement agency such as the FBI or Postal Inspection Service. - type: string enum: - ADDITIONAL_PROOF_OF_SHIPMENT description: Additional proof of shipment such as a packing list, detailed invoice, or shipping manifest to confirm that all items have been shipped. Include carrier name and tracking number if available. - type: string enum: - PROOF_OF_DENIAL_BY_CARRIER description: Documentation from the carrier should confirm the reason why they refuse to ship the item in question and the extent of the original damage. - type: string enum: - THIRDPARTY_PROOF_FOR_DAMAGE_OR_SIGNIFICANT_DIFFERENCE description: Proof should be provided by an unbiased third-party, such as a dealer, appraiser or another individual or organisation that's qualified in the area of the item in question (other than yourself), and detail the extent of the damage or clearly explain how the item received significantly differs from the item advertised. - type: string enum: - VALID_SUPPORTING_DOCUMENT description: The document you have provided doesn't support your claim that the item is Significantly Not as Described. Please provide a document to clearly show how the item received significantly differs from the item advertised. - type: string enum: - LEGIBLE_SUPPORTING_DOCUMENT description: The document you have provided is illegible, unclear, or too dark to read. Please provide a document that is legible and clear to read. - type: string enum: - RETURN_TRACKING_INFORMATION description: Online tracking information for remaining items that have to be shipped to the seller. - type: string enum: - DELIVERY_RECEIPT description: Confirmation that the item has been received. - type: string enum: - PROOF_OF_INSTORE_RECEIPT description: In-store receipt or online verification should clearly show that the buyer picked up the item. - type: string enum: - ADDITIONAL_TRACKING_INFORMATION description: Tracking information should include the carrier name, online tracking number and the website where the shipment can be tracked. - type: string enum: - PROOF_OF_SHIPMENT_POSTAGE description: Proof of shipment or postage should be a copy of the actual shipping label on the package that shows the destination address and the carrier's stamp to verify the shipment date. - type: string enum: - ONLINE_TRACKING_INFORMATION description: Online tracking information to confirm delivery of item. - type: string enum: - PROOF_OF_INSTORE_REFUND description: Proof should be an in-store refund receipt or company documentation that clearly shows a completed refund for the transaction. - type: string enum: - PROOF_FOR_SOFTWARE_OR_SERVICE_DELIVERED description: Proof should be compelling evidence to prove that the item or service was as described and was delivered to the buyer. Include information such as transaction ID, invoice ID, name or email to associate the evidence with the buyer along with date and time of the delivery. - type: string enum: - RETURN_ADDRESS_FOR_SHIPPING description: Return address is required for the buyer to ship the merchandise back to the seller. - type: string enum: - COPY_OF_THE_EPARCEL_MANIFEST description: "To validate a claim, a copy of the eparcel manifest showing the buyer's address from Australia Post is required. " - type: string enum: - COPY_OF_SHIPPING_MANIFEST description: The shipping manifest must show the buyer's address and can be obtained from the carrier. - type: string enum: - APPEAL_AFFIDAVIT description: Appeal affidavit is needed to make an appeal for any case outcome. - type: string enum: - RECEIPT_OF_REPLACEMENT description: Check with buyer if the replacement of the item sent by the seller was received - type: string enum: - COPY_OF_DRIVERS_LICENSE description: Need Copy of Drivers license. - type: string enum: - ACCOUNT_CHANGE_INFORMATION description: Additional Details about how account was accessed/what was changed. - type: string enum: - DELIVERY_ADDRESS description: Address where item was supposed to be delivered. - type: string enum: - CONFIRMATION_OF_RESOLUTION description: Confirmation that item was received and issue resolved. - type: string enum: - MERCHANT_RESPONSE description: Copy of merchant's response when the resolution was attempted. - type: string enum: - PERMISSION_DESCRIPTION description: A Detailed description about the account or card level permission given to another person. - type: string enum: - STATUS_OF_MERCHANDISE description: Details of the merchandise's current location. - type: string enum: - LOST_CARD_DETAILS description: Details of where and when the card was lost/stolen?. - type: string enum: - LAST_VALID_TRANSACTION_DETAILS description: Details of the last valid transaction made on the card. - type: string enum: - ADDITIONAL_PROOF_OF_RETURN description: Document to confirm that the item to be returned to the seller has been shipped. - type: string enum: - DECLARATION description: Signed declaration about the information provided. - type: string enum: - PROOF_OF_MISSING_ITEMS description: Image of open box with returned items and shipping label clearly visible. - type: string enum: - PROOF_OF_EMPTY_PACKAGE_OR_DIFFERENT_ITEM description: Image of empty box or returned items that are different from what were expected and shipping label clearly visible. - type: string enum: - PROOF_OF_ITEM_NOT_RECEIVED description: Any proof about the non receipt of the item, such as screenshot of tracking info. - type: string enum: - ORDER_DETAILS description: Order details or photos of the item/service/booking/digital download available on the website. - type: string enum: - LISTING_URL description: The website URLs of the item/service/booking/digital download. - type: string enum: - SHIPPING_INSURANCE description: Insurance information of the shipped item. - type: string enum: - BUYER_RESPONSE description: Copy of the buyer response or any other document showing buyer's understanding of the item/service/booking/digital download purchased. - type: string enum: - PHOTOS_OF_SHIPPED_ITEM description: Photos of the item that were shipped to the buyer. - type: string enum: - OTHER description: Other. - type: string enum: - CANCELLATION_DETAILS description: Cancellation details information, for example- cancellation date, cancellation number. - type: string enum: - MERCHANT_CONTACT_DETAILS description: Merchant contacted details information, for example- merchant contacted time, mode of contacting. - type: string enum: - ITEM_DETAILS description: Item related details information, for example- expected delivery date. - type: string enum: - CORRECT_RECIPIENT_INFORMATION description: Proof of the correct recipient name, email or phone. - type: string enum: - EXPLANATION_OF_FUNDS_NOT_DELIVERED description: Details on why the funds were not delivered to the correct recipient. - type: string enum: - CONFIRMATION_OF_RECALL description: Details of the recall confirmation from the customer. - type: string enum: - COMMUNICATION_WITH_THE_SENDER description: Messages or conversations exchanged with the sender. - type: string enum: - PAYMENT_REASON description: The reason or intent behind making the payment. - type: string enum: - PROOF_OF_EXPECTED_DELIVERY_DATE description: Any correspondence or documentation that provides the buyer with a proof of the anticipated date when a purchased item will be delivered. - type: string enum: - DELIVERY_DELAY_COMMUNICATION description: Any notification sent to the customer informing them that the expected delivery of an item has been delayed. - type: string enum: - ADDITIONAL_SCAM_DETAILS description: Any other details that suggest suspicious or fraudulent activity. - type: string enum: - REASON_FOR_LATE_OPENING description: Explanation for delayed reporting or response to the issue. - type: string enum: - COMMUNICATION_WITH_THE_RECIPIENT description: Messages or conversations exchanged with the recipient. - type: string enum: - EFFORTS_TO_VERIFY_RECIPIENT description: Steps taken to confirm the recipient’s identity or legitimacy. extensions: type: object title: Extensions description: The extended properties for the dispute. Includes additional information for a dispute category, such as billing disputes, the original transaction ID, and the correct amount. properties: merchant_contacted: type: boolean description: Indicates that the merchant was contacted. merchant_contacted_outcome: $ref: "#/components/schemas/merchant_contacted_outcome" merchant_contacted_time: description: The date and time when merchant was contacted. $ref: "#/components/schemas/date_time" merchant_contacted_mode: description: The method used to contact the merchant. $ref: "#/components/schemas/merchant_contacted_mode" buyer_contacted_time: description: The date and time when the buyer contacted the partner to file a dispute, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`. $ref: "#/components/schemas/date_time" buyer_contacted_channel: type: string minLength: 1 maxLength: 255 pattern: ^.*$ description: The channel through which the buyer contacted the partner to file a dispute. Partners that allow buyers to create dispute from multiple channels can use this field to help identify which channel was used for each individual dispute. billing_dispute_properties: $ref: "#/components/schemas/billing_disputes_properties" merchandize_dispute_properties: $ref: "#/components/schemas/merchandize_dispute_properties" reported_source: $ref: "#/components/schemas/dispute_source" fee_policy: type: object title: Fee Policy description: Policy that determines whether the fee needs to be charged, retained or returned while moving the money as part of dispute process. properties: {} fund_movement: type: object title: Fund movement description: This section contains the details about the fund movement of the parties ,time , direction and the reason for it. properties: party: type: string minLength: 1 maxLength: 255 pattern: ^[0-9A-Z_]+$ description: The affected party in the money movement. enum: - SELLER - BUYER - PAYMENT_PROCESSOR oneOf: - type: string enum: - SELLER description: The money movement is related to the seller. - type: string enum: - BUYER description: The money movement is related to the buyer. - type: string enum: - PAYMENT_PROCESSOR description: The money movement is related to the payment processing tenants such as PayPal, Venmo, Braintree etc. amount: description: The amount transferred as part of the money movement. $ref: "#/components/schemas/money" asset: description: The asset transferred as part of the money movement. $ref: "#/components/schemas/cryptocurrency" initiated_time: description: The date and time when the money movement was initiated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). $ref: "#/components/schemas/date_time" type: type: string minLength: 1 maxLength: 255 pattern: ^[0-9A-Z_]+$ description: The type of the money movement. enum: - DEBIT - CREDIT oneOf: - type: string enum: - DEBIT description: The money movement is a debit transaction. - type: string enum: - CREDIT description: The money movement is a credit transaction. reason: description: The reason for the fund movement. $ref: "#/components/schemas/fund_movement_reason" fund_movement_list: type: array minItems: 1 maxItems: 50 description: The movements of fund due to the dispute. items: $ref: "#/components/schemas/fund_movement" fund_movement_reason: type: string minLength: 1 maxLength: 255 pattern: ^[0-9A-Z_]+$ description: The reason for the fund movement. enum: - REVERSED_TRANSACTION_FEE - DISPUTE_SETTLEMENT - DISPUTE_FEE - CHARGEBACK_FEE oneOf: - type: string enum: - REVERSED_TRANSACTION_FEE description: The fee amount reimbursed to the seller as part of the dispute resolution process. - type: string enum: - DISPUTE_SETTLEMENT description: The money movement is for dispute settlement. - type: string enum: - DISPUTE_FEE description: The money movement is for dispute fee which PayPal charges to sellers for facilitating the online dispute resolution process for transactions that are processed either through a buyer’s PayPal account or through a PayPal guest checkout. - type: string enum: - CHARGEBACK_FEE description: The money movement is for chargeback fee which PayPal charges to sellers for facilitating the chargeback process for transactions that are not processed either through a buyer’s PayPal account or through a guest checkout, and where the buyer pursues a chargeback for the transaction with their card issuer. incorrect_transaction_amount: type: object title: Incorrect Transaction Amount description: The incorrect transaction amount details. properties: correct_transaction_amount: $ref: "#/components/schemas/money" correct_transaction_asset: description: The correct asset quantity of the transaction. $ref: "#/components/schemas/cryptocurrency" correct_transaction_time: description: The date and time when the customer created the transaction, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). $ref: "#/components/schemas/date_time" item_agreed_refund_details: {} item_booking_details: {} item_cancellation_details: {} item_digital_download_details: {} item_info: type: object title: Item Information description: The information for a purchased item in a disputed transaction. properties: item_id: type: string minLength: 1 maxLength: 255 pattern: ^.*$ description: The item ID. If the merchant provides multiple pieces of evidence and the transaction has multiple item IDs, the merchant can use this value to associate a piece of evidence with an item ID. item_name: type: string minLength: 1 maxLength: 2000 pattern: ^.*$ description: The item name. item_description: type: string minLength: 1 maxLength: 2000 pattern: ^(.|\r?\n)*$ description: The item description. item_quantity: type: string description: The count of the item in the dispute. Must be a whole number. minLength: 1 maxLength: 10 pattern: ^[1-9][0-9]{0,9}$ partner_transaction_id: type: string minLength: 1 maxLength: 255 pattern: ^[A-Za-z0-9]+$ description: The ID of the transaction in the partner system. The partner transaction ID is returned at an item level because the partner might show different transactions for different items in the cart. reason: $ref: "#/components/schemas/dispute_reason" dispute_amount: description: The amount of the item in the dispute. readOnly: true $ref: "#/components/schemas/money" notes: type: string minLength: 1 maxLength: 2000 pattern: ^(.|\r?\n)*$ description: Any notes provided with the item. item_type: $ref: "#/components/schemas/item_type" product_details: $ref: "#/components/schemas/item_product_details" service_details: $ref: "#/components/schemas/item_service_details" booking_details: $ref: "#/components/schemas/item_booking_details" digital_download_details: $ref: "#/components/schemas/item_digital_download_details" cancellation_details: $ref: "#/components/schemas/item_cancellation_details" agreed_refund_details: $ref: "#/components/schemas/item_agreed_refund_details" item_info_list: type: array minItems: 1 maxItems: 100 readOnly: true description: An array of items that were purchased as part of the transaction. items: $ref: "#/components/schemas/item_info" item_product_details: {} item_service_details: {} item_type: type: string minLength: 1 maxLength: 255 pattern: ^[0-9A-Z_]+$ title: Item Type description: The type of the item which has the issue. enum: - PRODUCT - SERVICE - BOOKING - DIGITAL_DOWNLOAD oneOf: - type: string enum: - PRODUCT description: The product has an issue. - type: string enum: - SERVICE description: The service has an issue. - type: string enum: - BOOKING description: The booking has an issue. - type: string enum: - DIGITAL_DOWNLOAD description: The digital download has an issue. items: type: object title: Items description: An 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. minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ 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). minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ method: type: string description: The HTTP method required to make the related call. minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ enum: - GET - POST - PUT - DELETE - HEAD - CONNECT - OPTIONS - PATCH oneOf: - type: string enum: - GET description: The HTTP GET method. - type: string enum: - POST description: The HTTP POST method. - type: string enum: - PUT description: The HTTP PUT method. - type: string enum: - DELETE description: The HTTP DELETE method. - type: string enum: - HEAD description: The HTTP HEAD method. - type: string enum: - CONNECT description: The HTTP CONNECT method. - type: string enum: - OPTIONS description: The HTTP OPTIONS method. - type: string enum: - PATCH description: The HTTP PATCH method. title: type: string description: The link title. minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ mediaType: type: string description: The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target. minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ encType: type: string description: The media type in which to submit the request data. default: application/json minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ schema: description: The schema that describes the request data. $ref: "#/components/schemas/link_schema" targetSchema: description: The schema that describes the link target. $ref: "#/components/schemas/link_schema" link_description_list: type: array description: An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either relevant to the issue by providing additional information or offering potential resolutions. readOnly: true minItems: 1 maxItems: 4 items: $ref: "#/components/schemas/link_description" link_schema: type: object title: Link Schema description: The request data or link target. properties: additionalItems: $ref: "#/components/schemas/additionalItems" dependencies: $ref: "#/components/schemas/dependencies" items: $ref: "#/components/schemas/items" patternProperties: $ref: "#/components/schemas/patternProperties" properties: $ref: "#/components/schemas/properties" allOf: $ref: "#/components/schemas/allOf_list" anyOf: $ref: "#/components/schemas/anyOf_list" oneOf: $ref: "#/components/schemas/oneOf_list" not: $ref: "#/components/schemas/not" links: $ref: "#/components/schemas/links_list" fragmentResolution: type: string description: The fragment resolution. minLength: 0 maxLength: 2147483647 pattern: ^[\S\s]*$ media: $ref: "#/components/schemas/media" pathStart: type: string format: uri description: To apply this schema to the instances' URIs, start the URIs with this value. minLength: 0 maxLength: 2147483647 links: type: object title: Link description: A link. readOnly: true links_list: type: array description: An array of links. readOnly: true items: $ref: "#/components/schemas/links" make_offer: type: object title: Make Offer Request description: A merchant request to make an offer to resolve a dispute. properties: note: type: string minLength: 1 maxLength: 2000 pattern: ^(.|\r?\n)*$ description: The merchant's notes about the offer. offer_amount: description: The amount proposed to resolve the dispute. $ref: "#/components/schemas/money" return_shipping_address: description: The return address for the item. Required when the customer must return an item to the merchant for the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED dispute reason,
especially if the refund amount is less than the dispute amount.
$ref: "#/components/schemas/address_portable"
deprecated: true
return_shipping_address_info:
$ref: "#/components/schemas/return_shipping_address_info"
invoice_id:
type: string
minLength: 1
maxLength: 127
description: The merchant-provided ID of the invoice for the refund. This
optional value maps the refund to an invoice ID in the merchant's
system.
pattern: ^.*$
offer_type:
$ref: "#/components/schemas/offer_type"
required:
- note
- offer_type
make_offer_response_options:
type: object
title: Make Offer Response Options
description: The allowed response options when the merchant makes offer to the
customer.
properties:
offer_types:
$ref: "#/components/schemas/offer_type_list"
media:
type: object
title: Media
description: The media type and context-encoding scheme.
properties:
type:
type: string
description: "The media type. See [Multipurpose Internet Mail Extensions (MIME)
Part Two: Media Types](https://tools.ietf.org/html/rfc2046)."
minLength: 0
maxLength: 2147483647
pattern: ^[\S\s]*$
binaryEncoding:
type: string
description: "The content-encoding scheme. See [Multipurpose Internet Mail
Extensions (MIME) Part One: Format of Internet Message
Bodies](https://tools.ietf.org/html/rfc2045)."
minLength: 0
maxLength: 2147483647
pattern: ^[\S\s]*$
merchandize_dispute_properties:
type: object
title: Merchandise Dispute Properties
description: The customer-provided merchandise issue details for the dispute.
properties:
issue_type:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
description: The issue type.
enum:
- PRODUCT
- SERVICE
oneOf:
- type: string
enum:
- PRODUCT
description: The product has an issue.
- type: string
enum:
- SERVICE
description: The service has an issue.
product_details:
$ref: "#/components/schemas/product_details"
service_details:
$ref: "#/components/schemas/service_details"
cancellation_details:
$ref: "#/components/schemas/cancellation_details"
return_shipping_address:
description: The return address for the item. Required when the customer must
return an item to the merchant for the MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED
dispute reason.
$ref: "#/components/schemas/address_portable"
merchant_contacted_mode:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
title: Merchant Contacted Method
description: The method used to contact the merchant.
enum:
- WEBSITE
- PHONE
- EMAIL
- WRITTEN
- IN_PERSON
oneOf:
- type: string
enum:
- WEBSITE
description: The merchant was contacted through his website.
- type: string
enum:
- PHONE
description: The merchant was contacted through either phone or fax.
- type: string
enum:
- EMAIL
description: The merchant was contacted through either email or text message.
- type: string
enum:
- WRITTEN
description: The merchant was contacted through a written communication.
- type: string
enum:
- IN_PERSON
description: The merchant was contacted in person.
merchant_contacted_outcome:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
title: Merchant Contacted Outcome
description: The outcome when the customer has contacted the merchant.
enum:
- NO_RESPONSE
- FIXED
- RESPONDED
- NOT_FIXED
oneOf:
- type: string
enum:
- NO_RESPONSE
description: The merchant did not respond to the customer.
- type: string
enum:
- FIXED
description: The merchant agreed to fix the issue but did not fix it yet.
- type: string
enum:
- RESPONDED
description: The merchant has responded.
- type: string
enum:
- NOT_FIXED
description: The merchant could not fix the issue.
message:
type: object
title: Message
description: A customer- or merchant-posted message for the dispute.
properties:
posted_by:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
description: Indicates whether the customer, merchant, or dispute arbiter posted
the message.
readOnly: true
enum:
- BUYER
- SELLER
- ARBITER
oneOf:
- type: string
enum:
- BUYER
description: The customer posted the message.
- type: string
enum:
- SELLER
description: The merchant posted the message.
- type: string
enum:
- ARBITER
description: The arbiter of the dispute posted the message.
time_posted:
readOnly: true
description: The date and time when the message was posted, in [Internet date
and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
$ref: "#/components/schemas/date_time"
content:
type: string
description: The message text.
maxLength: 2000
minLength: 0
pattern: ^(.|\r?\n)*$
documents:
$ref: "#/components/schemas/document_list"
message_list:
type: array
minItems: 1
maxItems: 1000
description: An array of customer- or merchant-posted messages for the dispute.
items:
$ref: "#/components/schemas/message"
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:offer_amount but
omit the return_shipping_address parameters from the
make offer request.
- type: string
enum:
- REFUND_WITH_RETURN
description: The customer must return the item to the merchant and then merchant
will refund the money. This offer type is valid in the inquiry phase
and occurs when a merchant is willing to refund a specific amount
and requires the customer to return the item. Include the
return_shipping_address parameter and the
offer_amount parameter in the make offer request.
- type: string
enum:
- REFUND_WITH_REPLACEMENT
description: The merchant must do a refund and then send a replacement item to
the customer. This offer type is valid in the inquiry phase when a
merchant is willing to refund a specific amount and send the
replacement item. Include the offer_amount parameter in
the make offer request.
- type: string
enum:
- REPLACEMENT_WITHOUT_REFUND
description: The merchant must send a replacement item to the customer with no
additional refunds. This offer type is valid in the inquiry phase
when a merchant is willing to replace the item without any refund.
Omit the offer_amount parameter from the make offer
request.
offer_type_list:
type: array
description: The types of offer the merchant can offer the customer.
minItems: 1
maxItems: 10
items:
$ref: "#/components/schemas/offer_type"
oneOf:
type: object
title: One Of Item
description: A sub-schema against which the data must validate.
oneOf_list:
type: array
description: An array of sub-schemas. The data must validate against one sub-schema.
items:
$ref: "#/components/schemas/oneOf"
patch:
type: object
title: Patch
description: The JSON patch object to apply partial updates to resources.
properties:
op:
type: string
description: The operation.
enum:
- add
- remove
- replace
- move
- copy
- test
oneOf:
- type: string
enum:
- add
description: Depending on the target location reference, completes one of these
functions:value parameter
defines the value to add. For more information, see 4.1.
add.
- type: string
enum:
- 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.
- type: string
enum:
- 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.
- type: string
enum:
- 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.
- type: string
enum:
- 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.
- type: string
enum:
- 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"
patternProperties:
type: object
title: Pattern Properties
description: The pattern properties.
payment_by_other_means:
type: object
title: Payment by Other Means
description: The payment by other means details.
properties:
charge_different_from_original:
type: boolean
description: If `true`, indicates that a charge was made that is different from
the original charge.
received_duplicate:
type: boolean
description: If `true`, indicates that a duplicate transaction was received.
payment_method:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
description: The payment method.
enum:
- CASH
- CREDIT_CARD
- CHECK
- PAYPAL
- DEBIT_CARD
- GIFT_CARD
- BANK_TRANSFER
oneOf:
- type: string
enum:
- CASH
description: The payment method was cash.
- type: string
enum:
- CREDIT_CARD
description: The payment method was a credit card.
- type: string
enum:
- CHECK
description: The payment method was a check.
- type: string
enum:
- PAYPAL
description: The payment method was PayPal.
- type: string
enum:
- DEBIT_CARD
description: The payment method was a debit card.
- type: string
enum:
- GIFT_CARD
description: The payment method was a gift card.
- type: string
enum:
- BANK_TRANSFER
description: The payment method was through bank transfer.
payment_instrument_suffix:
type: string
minLength: 2
maxLength: 4
pattern: ^.*$
description: Last 2-4 characters of the payment instrument. For payment_method
CHECK, payment_instrument_suffix entered must be of minimum length
2-4 characters. For payment_method CREDIT_CARD, DEBIT_CARD,
GIFT_CARD, BANK_TRANSFER, payment_instrument_suffix entered must be
of length 4.
payment_processor: {}
product_details:
type: object
title: Product Details
description: The product information.
properties:
description:
description: The product description.
type: string
minLength: 1
maxLength: 2000
pattern: ^(.|\r?\n)*$
product_received:
description: Indicates whether the product was, or was not, received or returned.
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
enum:
- YES
- NO
- RETURNED
oneOf:
- type: string
enum:
- YES
description: The product was received.
- type: string
enum:
- NO
description: The product was not received.
- type: string
enum:
- RETURNED
description: The product was returned.
product_received_time:
description: The date and time when product was delivered.
$ref: "#/components/schemas/date_time"
expected_delivery_date:
description: The expected delivery date and time of the product.
$ref: "#/components/schemas/date_time"
sub_reasons:
$ref: "#/components/schemas/sub_reasons_list"
purchase_url:
type: string
format: uri
description: The URL where the customer purchased the product.
return_details:
$ref: "#/components/schemas/return_details"
properties:
type: object
title: Properties
description: Properties.
refund_details:
type: object
title: Refund Details
description: The refund details.
properties:
allowed_refund_amount:
description: The maximum refundable amount.
$ref: "#/components/schemas/money"
transactions:
$ref: "#/components/schemas/refund_transaction_list"
refund_ids:
type: string
minLength: 1
maxLength: 255
description: The ID of the refunded transaction.
refund_ids_list:
type: array
minItems: 1
maxItems: 100
description: An array of refund IDs for the transaction involved in this dispute.
items:
$ref: "#/components/schemas/refund_ids"
refund_transaction:
type: object
title: Refund Transaction
description: The refund transaction details.
properties:
id:
type: string
minLength: 1
maxLength: 255
pattern: ^[A-Za-z0-9]+$
description: The ID of the transaction for the refund or recovery.
gross_amount:
description: The gross amount of the refund.
$ref: "#/components/schemas/money"
create_time:
description: The date and time of the refund in [Internet date and time
format](https://tools.ietf.org/html/rfc3339#section-5.6). For
example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.
$ref: "#/components/schemas/date_time"
refund_transaction_list:
type: array
minItems: 1
maxItems: 100
description: An array of refund transactions associated with the dispute.
items:
$ref: "#/components/schemas/refund_transaction"
require_evidence:
type: object
title: Require Evidence Request
description: Sandbox only. Updates the state of a dispute, by ID, to either
WAITING_FOR_BUYER_RESPONSE or
WAITING_FOR_SELLER_RESPONSE. This state change enables
either the customer or merchant to submit evidence for the dispute.
Specify an action value in the JSON request body to
indicate whether the state change enables the customer or merchant to
submit evidence.
properties:
action:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
description: The action. Indicates whether the state change enables the customer
or merchant to submit evidence.
enum:
- BUYER_EVIDENCE
- SELLER_EVIDENCE
oneOf:
- type: string
enum:
- BUYER_EVIDENCE
description: Changes the status of the dispute to
WAITING_FOR_BUYER_RESPONSE.
- type: string
enum:
- SELLER_EVIDENCE
description: Changes the status of the dispute to
WAITING_FOR_SELLER_RESPONSE.
required:
- action
return_details:
type: object
title: Return Details
description: The return details for the product.
properties:
return_time:
description: The date and time when the product was returned, [Internet date and
time format](http://tools.ietf.org/html/rfc3339#section-5.6).
$ref: "#/components/schemas/date_time"
mode:
description: The method that the customer used to return the product.
type: string
minLength: 1
maxLength: 255
pattern: ^[A-Z_]+$
enum:
- SHIPPED
- IN_PERSON
oneOf:
- type: string
enum:
- SHIPPED
description: The customer shipped the product back to the merchant.
- type: string
enum:
- IN_PERSON
description: The customer returned the item to the merchant in person.
receipt:
type: boolean
description: Indicates whether customer has the return receipt.
return_confirmation_number:
type: string
minLength: 1
maxLength: 255
pattern: ^[A-Za-z0-9:\-]+$
description: The confirmation number for the item return.
returned:
description: If `true`, indicates that the item was returned but the seller
refused to accept the return and if `false`, indicates the item was
not attempted to return.
type: boolean
return_shipping_address_info:
type: object
title: Return shipping address information
description: Merchant provided information regarding return shipping address.
properties:
save_to_profile:
type: boolean
description: The merchant's preference to save the return shipping address to
their account profile.
address:
description: The return address for the item. Required when the customer must
return an item to the merchant for the
MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED dispute reason,
especially if the refund amount is less than the dispute amount.
$ref: "#/components/schemas/address_portable"
seller:
type: object
title: Merchant
description: The details for the merchant who receives the funds and fulfills
the order. For example, merchant ID, and contact email address.
properties:
email:
description: The email address for the merchant's PayPal account.
$ref: "#/components/schemas/email_address"
merchant_id:
type: string
minLength: 1
maxLength: 255
description: The PayPal account ID for the merchant.
pattern: ^[0-9A-Za-z]+$
name:
type: string
minLength: 1
maxLength: 2000
pattern: ^[^~!@#$%^*()_{}:|\t\n/]+$
description: The name of the merchant.
service_details:
type: object
title: Service Details
description: The service details.
properties:
description:
description: The service description.
type: string
minLength: 1
maxLength: 2000
pattern: ^(.|\r?\n)*$
service_started:
description: Indicates whether the service was started or cancelled.
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
enum:
- YES
- NO
- CANCELLED
oneOf:
- type: string
enum:
- YES
description: The service was started.
- type: string
enum:
- NO
description: The service was not started.
- type: string
enum:
- CANCELLED
description: The service was cancelled.
note:
description: The customer specified note about the service usage.
type: string
minLength: 1
maxLength: 2000
pattern: ^(.|\r?\n)*$
sub_reasons:
$ref: "#/components/schemas/definitions-sub_reasons_list"
purchase_url:
type: string
format: uri
description: The URL of the merchant or marketplace site where the customer
purchased the service.
status:
type: string
minLength: 1
maxLength: 255
readOnly: true
pattern: ^[0-9A-Z_]+$
description: The overall status of the dispute, constant for all the parties
involved at anytime during the dispute lifecycle.
enum:
- OPEN
- WAITING_FOR_BUYER_RESPONSE
- WAITING_FOR_SELLER_RESPONSE
- UNDER_REVIEW
- RESOLVED
- OTHER
oneOf:
- type: string
enum:
- OPEN
description: The dispute is open.
- type: string
enum:
- WAITING_FOR_BUYER_RESPONSE
description: The dispute is waiting for a response from the customer.
- type: string
enum:
- WAITING_FOR_SELLER_RESPONSE
description: The dispute is waiting for a response from the merchant.
- type: string
enum:
- UNDER_REVIEW
description: The dispute is under review with PayPal.
- type: string
enum:
- RESOLVED
description: The dispute is resolved.
- type: string
enum:
- OTHER
description: The default status if the dispute does not have one of the other
statuses.
sub_reasons:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
description: The sub-reason for the product issue.
enum:
- DAMAGED
- DIFFERENT
- MISSING_PARTS
- OTHER
oneOf:
- type: string
enum:
- DAMAGED
description: The product was damaged.
- type: string
enum:
- DIFFERENT
description: The product was different from what was expected.
- type: string
enum:
- MISSING_PARTS
description: The product had missing parts.
- type: string
enum:
- OTHER
description: Other.
sub_reasons_list:
description: An array of sub-reasons for the product issue.
type: array
minItems: 1
maxItems: 10
items:
$ref: "#/components/schemas/sub_reasons"
subsequent_action:
title: Subsequent Action
type: object
description: The subsequent action.
properties:
links:
$ref: "#/components/schemas/subsequent_action_definitions-link_description_list"
subsequent_action_definitions-link_description_list:
type: array
minItems: 1
maxItems: 10
description: An array of request-related [HATEOAS
links](/docs/api/reference/api-responses/#hateoas-links/).
readOnly: true
items:
$ref: "#/components/schemas/link_description"
supporting_info:
type: object
title: Supporting Info
description: A merchant- or customer-submitted supporting information.
properties:
notes:
type: string
readOnly: true
description: Any supporting notes.
minLength: 1
maxLength: 2000
pattern: ^(.|\r?\n)*$
documents:
$ref: "#/components/schemas/supporting_info_definitions-document_list"
source:
type: string
minLength: 1
maxLength: 255
readOnly: true
pattern: ^[0-9A-Z_]+$
description: The source of the Information.
enum:
- SUBMITTED_BY_BUYER
- SUBMITTED_BY_SELLER
- SUBMITTED_BY_PARTNER
oneOf:
- type: string
enum:
- SUBMITTED_BY_BUYER
description: Information was submitted by the customer.
- type: string
enum:
- SUBMITTED_BY_SELLER
description: Information was submitted by the merchant.
- type: string
enum:
- SUBMITTED_BY_PARTNER
description: Information was submitted by the partner.
provided_time:
readOnly: true
description: The date and time when the information was received, in [Internet
date and time
format](http://tools.ietf.org/html/rfc3339#section-5.6).
$ref: "#/components/schemas/date_time"
dispute_life_cycle_stage:
readOnly: true
description: The dispute life cycle stage for the supporting info.
$ref: "#/components/schemas/dispute_lifecycle_stage"
supporting_info_definitions-document_list:
type: array
minItems: 1
maxItems: 100
readOnly: true
description: An array of metadata for the documents which were uploaded as
supporting information for the dispute.
items:
$ref: "#/components/schemas/document"
supporting_info_list:
type: array
readOnly: true
minItems: 1
maxItems: 100
description: An array of all the supporting information that are associated to
this dispute.
items:
$ref: "#/components/schemas/supporting_info"
tracking_info:
type: object
title: Tracking Information
description: The tracking information.
properties:
carrier_name:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
description: The name of the shipment carrier for the transaction for this
dispute.
enum:
- UPS
- USPS
- FEDEX
- AIRBORNE_EXPRESS
- DHL
- AIRSURE
- ROYAL_MAIL
- PARCELFORCE
- SWIFTAIR
- OTHER
- UK_PARCELFORCE
- UK_ROYALMAIL_SPECIAL
- UK_ROYALMAIL_RECORDED
- UK_ROYALMAIL_INT_SIGNED
- UK_ROYALMAIL_AIRSURE
- UK_UPS
- UK_FEDEX
- UK_AIRBORNE_EXPRESS
- UK_DHL
- UK_OTHER
- UK_CANNOT_PROV_TRACK
- UK_CANNOT_PROVIDE_TRACKING
- CA_CANADA_POST
- CA_PUROLATOR
- CA_CANPAR
- CA_LOOMIS
- CA_TNT
- TNT
- CA_OTHER
- CA_CANNOT_PROV_TRACK
- DE_DP_DHL_WITHIN_EUROPE
- DE_DP_DHL_T_AND_T_EXPRESS
- DE_DHL_DP_INTL_SHIPMENTS
- CA_CANNOT_PROVIDE_TRACKING
- DE_GLS
- DE_DPD_DELISTACK
- DE_HERMES
- DE_UPS
- DE_FEDEX
- DE_TNT
- DE_OTHER
- FR_CHRONOPOST
- FR_COLIPOSTE
- FR_DHL
- FR_UPS
- FR_FEDEX
- FR_TNT
- FR_GLS
- FR_OTHER
- IT_POSTE_ITALIA
- IT_DHL
- IT_UPS
- IT_FEDEX
- IT_TNT
- IT_GLS
- IT_OTHER
- AU_AUSTRALIA_POST_EP_PLAT
- AU_AUSTRALIA_POST_EPARCEL
- AU_AUSTRALIA_POST_EMS
- AU_DHL
- AU_STAR_TRACK_EXPRESS
- AU_UPS
- AU_FEDEX
- AU_TNT
- AU_TOLL_IPEC
- AU_OTHER
- FR_SUIVI
- IT_EBOOST_SDA
- ES_CORREOS_DE_ESPANA
- ES_DHL
- ES_UPS
- ES_FEDEX
- ES_TNT
- ES_OTHER
- AT_AUSTRIAN_POST_EMS
- AT_AUSTRIAN_POST_PPRIME
- BE_CHRONOPOST
- BE_TAXIPOST
- CH_SWISS_POST_EXPRES
- CH_SWISS_POST_PRIORITY
- CN_CHINA_POST
- HK_HONGKONG_POST
- IE_AN_POST_SDS_EMS
- IE_AN_POST_SDS_PRIORITY
- IE_AN_POST_REGISTERED
- IE_AN_POST_SWIFTPOST
- IN_INDIAPOST
- JP_JAPANPOST
- KR_KOREA_POST
- NL_TPG
- SG_SINGPOST
- TW_CHUNGHWA_POST
- CN_CHINA_POST_EMS
- CN_FEDEX
- CN_TNT
- CN_UPS
- CN_OTHER
- NL_TNT
- NL_DHL
- NL_UPS
- NL_FEDEX
- NL_KIALA
- BE_KIALA
- PL_POCZTA_POLSKA
- PL_POCZTEX
- PL_GLS
- PL_MASTERLINK
- PL_TNT
- PL_DHL
- PL_UPS
- PL_FEDEX
- JP_SAGAWA_KYUU_BIN
- JP_NITTSU_PELICAN_BIN
- JP_KURO_NEKO_YAMATO_UNYUU
- JP_TNT
- JP_DHL
- JP_UPS
- JP_FEDEX
- NL_PICKUP
- NL_INTANGIBLE
- NL_ABC_MAIL
- HK_FOUR_PX_EXPRESS
- HK_FLYT_EXPRESS
- US_ASCENDIA
- US_ENSENDA
- US_GLOBEGISTICS
- US_ONTRAC
- RRDONNELLEY
- ASENDIA_UK
- UK_COLLECTPLUS
- UK_DPD
- UK_HERMESWORLD
- UK_INTERLINK_EXPRESS
- UK_TNT
- UK_UK_MAIL
- UK_YODEL
- BUYLOGIC
- CN_EMS
- CHINA_POST
- CNEXPS
- CPACKET
- CUCKOOEXPRESS
- CN_EC
- CN_EMPS
- DE_ASENDIA
- UK_DELTEC
- DE_DEUTSCHE
- DE_DPD
- RABEN_GROUP
- GLOBAL_TNT
- ADSONE
- AU_AU_POST
- BONDSCOURIERS
- COURIERS_PLEASE
- DTDC_AU
- AU_FASTWAY
- HUNTER_EXPRESS
- SENDLE
- AUS_TOLL
- TOLL
- UBI_LOGISTICS
- OMNIPARCEL
- QUANTIUM
- CN_SF_EXPRESS
- SEKOLOGISTICS
- HK_TAQBIN
- GB_APC
- CA_CANPAR_COURIER
- GLOBAL_ESTES
- CA_GREYHOUND
- PUROLATOR
- US_RL
- IT_BRT
- DMM_NETWORK
- IT_FERCAM
- HERMES_IT
- IT_POSTE_ITALIANE
- IT_SDA
- IT_SGT
- GLOBAL_SKYNET
- FR_BERT
- FR_COLIS
- FR_GEODIS
- FR_LAPOSTE
- FR_TELIWAY
- DPD_POLAND
- INPOST_PACZKOMATY
- POL_POCZTA
- POL_SIODEMKA
- ESP_CORREOS
- ES_CORREOS
- ESP_NACEX
- ESP_ASM
- ESP_REDUR
- CBL_LOGISTICA
- EKART
- IND_DELHIVERY
- IND_BLUEDART
- IND_DTDC
- IND_PROFESSIONAL_COURIERS
- IND_REDEXPRESS
- IND_XPRESSBEES
- IND_DOTZOT
- THA_KERRY
- SENDIT
- ACOMMERCE
- NINJAVAN_THAI
- NIM_EXPRESS
- THA_THAILAND_POST
- THA_DYNAMIC_LOGISTICS
- ALPHAFAST
- FASTRAK_TH
- EPARCEL_KR
- CJ_KOREA_THAI
- RINCOS
- KOR_KOREA_POST
- KOR_CJ
- KOR_ECARGO
- SREKOREA
- ROCKETPARCEL
- BG_BULGARIAN_POST
- JPN_JAPAN_POST
- JPN_YAMATO
- JPN_SAGAWA
- TUR_PTT
- AUT_AUSTRIAN_POST
- AU_AUSTRIAN_POST
- RUSSIAN_POST
- BEL_DHL
- FR_MONDIAL
- EU_BPOST
- LANDMARK_GLOBAL
- IDN_POS
- IDN_POS_INT
- IDN_JNE
- IDN_PANDU
- RPX
- IDN_TIKI
- IDN_LION_PARCEL
- NINJAVAN_ID
- IDN_WAHANA
- IDN_FIRST_LOGISTICS
- UK_AN_POST
- DPD
- UK_FASTWAY
- UK_NIGHTLINE
- WISELOADS
- GR_ELTA
- GRC_ACS
- GR_GENIKI
- NINJAVAN_PHILIPPINES
- PHL_XEND_EXPRESS
- PHL_LBC
- PHL_JAMEXPRESS
- PHL_AIRSPEED
- PHL_RAF
- DIRECTLOG
- BRA_CORREIOS
- NLD_DHL
- NLD_POSTNL
- NLD_GLS
- NLD_TRANSMISSION
- CORREOS_DE_MEXICO
- MEX_ESTAFETA
- MEX_SENDA
- MEX_REDPACK
- MEX_AEROFLASH
- NATIONWIDE_MY
- MYS_MYS_POST
- MYS_TAQBIN
- MYS_SKYNET
- MYS_CITYLINK
- MYS_AIRPAK
- NINJAVAN_MY
- KANGAROO_MY
- VNM_VIETNAM_POST
- VNPOST_EMS
- PRT_INT_SEUR
- PRT_CTT
- PRT_CHRONOPOST
- PRT_SEUR
- ADICIONAL
- LTU_LIETUVOS
- DPEX
- LWE_HK
- SG_SG_POST
- SG_TAQBIN
- SG_NINJAVAN
- SG_ZALORA
- JET_SHIP
- SG_PARCELPOST
- CHE_SWISS_POST
- ASENDIA_HK
- HUN_MAGYAR
- POSTNORD_LOGISTICS
- SWE_DIRECTLINK
- SWE_POSTNORD
- SWE_DB
- CZE_CESKA
- NZ_NZ_POST
- NZ_COURIER_POST
- FASTWAY_NZ
- TW_TAIWAN_POST
- SPREADEL
- ARE_EMIRATES_POST
- AXL
- CYP_CYPRUS_POST
- HRV_HRVATSKA
- NOR_POSTEN
- RAM
- THECOURIERGUY
- ZA_FASTWAY
- DPE_EXPRESS
- POSTI
- MATKAHUOLTO
- GLOBAL_DHL
- ARG_CORREO
- ARG_OCA
- POST_SERBIA
- BH_POSTA
- CORREOS_CHILE
- APR_72
- CORREOS_DE_COSTA_RICA
- POSTUR_IS
- SPEEDEXCOURIER
- ROU_POSTA
- UKR_NOVA
- UKR_POSHTA
- NGA_NIPOST
- NG_COURIERPLUS
- ESHOPWORLD
- WEBINTERPRET
- HERMES
- ABC_MAIL
- ARAMEX
- YANWEN
- INTERNATIONAL_BRIDGE
- SFC_LOGISTICS
- BQC_EXPRESS
- ONE_WORLD
- IT_REGISTER_MAIL
- WINIT
- CONTINENTAL
- EFS
- PANTOS
- RELAIS_COLIS
- US_DHL_EXPRESS
- US_DHL_PARCEL
- US_DHL_ECOMMERCE
- US_DHL_GLOBALFORWARDING
- UK_DHL_EXPRESS
- UK_DHL_PARCEL
- UK_DHL_GLOBALFORWARDING
- CN_DHL_EXPRESS
- CN_DHL_ECOMMERCE
- CN_DHL_GLOBALFORWARDING
- DE_DHL_EXPRESS
- DE_DHL_PARCEL
- DE_DHL_PACKET
- DE_DHL_ECOMMERCE
- DE_DHL_GLOBALFORWARDING
- DE_DHL_DEUTSCHEPOST
- AU_DHL_EXPRESS
- AU_DHL_ECOMMERCE
- AU_DHL_GLOBALFORWARDING
- HK_DHL_EXPRESS
- HK_DHL_ECOMMERCE
- HK_DHL_GLOBALFORWARDING
- CA_DHL_EXPRESS
- CA_DHL_ECOMMERCE
- CA_DHL_GLOBALFORWARDING
- IT_DHL_EXPRESS
- IT_DHL_ECOMMERCE
- IT_DHL_GLOBALFORWARDING
- FR_DHL_EXPRESS
- FR_DHL_PARCEL
- FR_DHL_GLOBALFORWARDING
- PL_DHL_EXPRESS
- PL_DHL_PARCEL
- PL_DHL_GLOBALFORWARDING
- ABC_PACKAGE
- AN_POST
- APC_OVERNIGHT
- ASM_ES
- AUPOST_CN
- ACOMMMERCE
- ADICIONAL_PT
- AIR_21
- AIRBORNE_EXPRESS_UK
- AIRPAK_MY
- AIRSPEED
- ASENDIA_DE
- ASENDIA_US
- AUSTRALIA_POST
- TOLL_AU
- AUSTRIAN_POST_EXPRESS
- AUSTRIAN_POST
- B_TWO_C_EUROPE
- BERT
- BPOST
- BRT_IT
- BLUEDART
- BONDS_COURIERS
- BPOST_INT
- BULGARIAN_POST
- CJ_LOGISTICS
- CJ_INT_MY
- CJ_MY
- CJ_TH
- CANADA_POST
- CANPAR
- CESKA_CZ
- CHRONOPOST_FR
- CHRONOPOST_PT
- CHUNGHWA_POST
- CITYLINK_MY
- COLIPOSTE
- COLIS
- COLLECTPLUS
- CORREOS_AG
- CORREOS_BR
- CORREOS_CL
- CORREOS_CR
- CORREOS_MX
- CORREOS_ES
- CORREOS_EXPRESS
- COURIERPLUS
- COURIER_POST
- CYPRUS_POST_CYP
- DBSCHENKER_SE
- DHL_ES
- DHL_ACTIVE_TRACING
- DHL_AU
- DHL_BENELUX
- DHL_DEUTSCHE_POST
- DHL_FR
- DHL_GLOBAL_ECOMMERCE
- DHL_HK
- DHL_IT
- DHL_JP
- DHL_NL
- DHL_PACKET
- DHL_PARCEL_NL
- DHL_PARCEL_ES
- DHL_PL
- DHL_SG
- DHL_UK
- DHL_GLOBAL_MAIL_ASIA
- DHL_GLOBAL_MAIL
- DHL_AT
- DPD_DELISTRACK
- DPD_FR
- DPD_DE
- DPD_HK
- DPD_IR
- DPD_LOCAL_REF
- DPD_LOCAL
- DPD_PL
- DPD_RO
- DPD_RU
- DPD_UK
- DTDC_EXPRESS
- DTDC_IN
- DAWN_WING
- DELHIVERY_IN
- DELTEC_DE
- DELTEC_UK
- DEUTSCHE_DE
- DIRECTLINK_SE
- DIRECTLOG_BR
- DOTZOT
- EC_CN
- ELTA_GR
- EMPS_CN
- EMS_CN
- ECARGO
- EMIRATES_POST
- ENSENDA
- ESTAFETA
- ESTES
- FERCAM_IT
- FLYT_EXPRESS
- FASTRACK
- FASTWAY_US
- FASTWAY_ZA
- FASTWAY_UK
- FASTWAY_AU
- FIRST_LOGISITCS
- FOUR_PX_EXPRESS
- GEODIS
- GLS_CZ
- GLS_FR
- GLS_DE
- GLS_IT
- GLS_NL
- GLS_ES
- GLS
- ACS_GR
- GENIKI_GR
- GLOBEGISTICS
- GREYHOUND
- HERMES_DE
- HERMESWORLD_UK
- HK_POST
- HRVATSKA_HR
- HUAHAN_EXPRESS
- IMX
- ITIS
- INDIA_POST
- INTERLINK
- INT_SEUR
- INT_SUER
- ISRAEL_POST
- JNE_IDN
- JAMEXPRESS_PH
- JAPAN_POST
- JP_POST
- JETSHIP_MY
- JETSHIP_SG
- KERRY_EXPRESS_VN
- KERRY_EXPRESS_HK
- KERRY_EXPRESS_TH
- KIALA
- KOREA_POST
- CJ_KR
- LAPOSTE
- LBC_PH
- LIETUVOS_LT
- LION_PARCEL
- LOGISTICSWORLDWIDE_HK
- LOGISTICSWORLDWIDE_KR
- LOGISTICSWORLDWIDE_MY
- LOOMIS
- MONDIAL
- MAGYAR_HU
- MALAYSIA_POST
- MASTERLINK
- AEROFLASH
- REDPACK
- SENDA_MX
- MONDIAL_BE
- MYHERMES
- NACEX_ES
- NATIONWIDE
- NZ_POST
- NIPOST_NG
- NIGHTLINE_UK
- NINJAVAN_PH
- NINJAVAN_SG
- NOVA_POSHTA_INT
- NOVA_POSHTA
- OCA_AR
- ONTRAC
- PTT_POST
- PANDU
- PARCELPOST_SG
- POCZTA_POLSKA
- POCZTEX
- CTT_PT
- SEUR_PT
- POS_ID
- POS_INT
- POSTNL_INT_3_S
- POSTNL
- POSTNL_INT
- POSTNORD_LOGISTICS_DK
- POSTNORD_LOGISTICS_SE
- POSTNORD_LOGISTICS_GLOBAL
- POSTA_RO
- POSTE_ITALIANE
- POSTEN_NORGE
- PROFESSIONAL_COURIERS
- RAF_PH
- RL_US
- RPD_2_MAN
- RPX_ID
- REDEXPRESS
- REDUR_ES
- REGISTER_MAIL_IT
- RELAIS_COLIS_FR
- ROCKET_PARCEL
- SDA_IT
- SF_EXPRESS
- SFC_EXPRESS
- SGT_IT
- SRE_KOREA
- SAGAWA
- SAGAWA_JP
- POST_SERBIA_CS
- SINGPOST
- SIODEMKA
- SKYNET_WORLDWIDE
- SKYNET_MY
- SKYNET_UAE
- SKYNET_UK
- SEUR_ES
- STARTRACK_EXPRESS
- STARTRACK
- SWISS_POST
- TNT_AU
- TNT_CN
- TNT_CLICK_IT
- TNT_FR
- TNT_DE
- TNT_IT
- TNT_JP
- TNT_NL
- TNT_PL
- TNT_ES
- TNT_UK
- TPG
- TAIWAN_POST_TW
- TAQBIN_HK
- TAQBIN_MY
- TAQBIN_SG
- TAXIPOST
- TELIWAY
- THAILAND_POST
- THE_COURIER_GUY
- TIKI_ID
- TOLL_IPEC
- TWO_GO
- TRANSMISSION
- UK_MAIL
- UPS_MI
- VIETNAM_POST
- WAHANA_ID
- XEND_EXPRESS_PH
- XPRESSBEES
- YAMATO
- YANWEN_CN
- YODEL
- UPS_CANADA
- UPS_MAIL_INNOVATIONS
- DE_DELTEC
- DE_INTERNATIONALSEUR
- FR_DPD
- FR_IMX
- IT_IMX
- AU_DTDC
- AU_SENDLE
- AU_SKYNET
- ES_GLS
- ES_INTERNATIONALSEUR
- ES_IMX
- CN_HUAHANEXPRESS
- LOCAL_PICKUP
- HK_DPEX
- HK_KERRYEXPRESS
- HK_LOGISTICSWORLDWIDEEXPRESS
- HK_RPX
- HK_SPREADEL
- IN_SPREADEL
- TH_CJ
- KR_LOGISTICSWORLDWIDE
- AT_DHL
- BE_IMX
- MY_LOGISTICSWORLDWIDE
- MY_JETSHIP
- SG_DHL
- SG_SPREADEL
- POSTAROMANA
- US_PUROLATOR
- US_FASTWAY
- CHRONOPOST
- CORREOS_DE_ESPANA
- DEUTSCHE_POST_DHL
- EBOOST_SDA
- HONGKONG_POST
- INTANGIBLE_DIGITAL_SERVICES
- LA_POSTE
- LA_POSTE_SUIVI
- NEKO_YAMATO_UNYUU
- NITTSU_PELICAN_BIN
- POSTE_ITALIA
- SAGAWA_KYUU_BIN
- STAR_TRACK_EXPRESS
- US_DTDC
- US_STARTRACK
- ISR_ISRAEL_POST
- BE_MONDIAL
- B_2_CEUROPE
- PHL_2_GO
- PHL_AIR_21
- PT_SPANISH_SEUR
- ES_SPANISH_SEUR
- SG_DPEX
- CH_IMX
- DHLG
- RUSTON
- MIKROPAKKET
- XPOST
- PAN_ASIA
- PARCELONE
- SPEEDEE
- VENIPAK
- CROSHOT
- SHREENANDANCOURIER
- EPST_GLBL
- NEWGISTICS
- POST_SLOVENIA
- JERSEY_POST
- WMG
- BOMBINOEXP
- XQ_EXPRESS
- FURDECO
- LEGION_EXPRESS
- YDH_EXPRESS
- LHT_EXPRESS
- SOUTH_AFRICAN_POST_OFFICE
- GRUPO
- SPOTON
- DIMERCO
- INTERPARCEL_UK
- ABCUSTOM
- IND_DELIVREE
- GLOBAL_ABF
- CN_BESTEXPRESS
- DX_SFTP
- PICKUPP_MYS
- XPERT_DELIVERY
- FMX
- HELLMANN
- DHL_REFR
- DHL_HK
- SHIP_IT_ASIA
- KERRY_ECOMMERCE
- GOJEK
- FRETERAPIDO
- YODEL_INTNL
- CFL_LOGISTICS
- PITNEY_BOWES
- ZA_SPECIALISED_FREIGHT
- JANCO
- XPRESSEN_DK
- YTO
- RPD2MAN
- SEUR_SP_API
- DELIVERYONTIME
- WISE_EXPRESS
- JINSUNG
- JTEXPRESS_VN
- CHUKOU1
- TRANS_KARGO
- FEDEX_INTL_MLSERV
- SWISHIP_DE
- IVOY_WEBHOOK
- AIRMEE_WEBHOOK
- VAMOX
- FIRSTMILE
- AMS_GRP
- FASTWAY_IR
- HH_EXP
- HRPARCEL
- MYS_MYPOST_ONLINE
- GESWL
- BLUESTAR
- TIPSA
- CDEK_TR
- KGMHUB
- INTEXPRESS
- DESCARTES
- OVERSE_EXP
- ONECLICK
- ROADRUNNER_FREIGHT
- GLS_CROTIA
- TOURLINE
- MRW_FTP
- BH_WORLDWIDE
- BLUEX
- DYLT
- OCS
- YINGNUO_LOGISTICS
- SIN_GLBL
- TUFFNELLS_REFERENCE
- CJPACKET
- MILKMAN
- FIEGE_NL
- ASIGNA
- ONEWORLDEXPRESS
- LTIANEXP
- KWE_GLOBAL
- CTC_EXPRESS
- LAO_POST
- EU_IMX
- GLS_SLOV
- AMAZON
- MORE_LINK
- JX
- MYS_EMS
- EASY_MAIL
- ADUIEPYLE
- GB_PANTHER
- SG_DETRACK
- EXPRESSSALE
- DICOM
- MATDESPATCH
- TRUNKRS_WEBHOOK
- WESTBANK_COURIER
- MBW
- KHM_CAMBODIA_POST
- FEDEX_CROSSBORDER
- JANIO
- SINOTRANS
- BRT_IT_PARCELID
- A1POST
- DHL_SUPPLY_CHAIN
- TAZMANIAN_FREIGHT
- TOPYOU
- PALEXPRESS
- SAIA_FREIGHT
- CN_WEDO
- FULFILLME
- SG_QXPRESS
- UPS_REFERENCE
- NHANS_SOLUTIONS
- CARIBOU
- LOCUS_WEBHOOK
- DSV
- CN_GOFLY
- COORDINADORA
- P2P_TRC
- ANDREANI
- DIRECTPARCELS
- DOORA
- FEDEX_POLAND
- INTERPARCEL_NZ
- XDP_UK_REFERENCE
- ETOMARS
- CN_JCEX
- IND_ECOM
- FAR_INTERNATIONAL
- ESP_ENVIALIA
- IDEXPRESS
- GANGBAO
- SMSA_EXPRESS
- NEWAY
- DEX_I
- DESIGNERTRANSPORT_WEBHOOK
- BUDBEE_WEBHOOK
- GLS_SLOVEN
- PARCELLED_IN
- COPA_COURIER
- GSI_EXPRESS
- CON_WAY
- BROUWER_TRANSPORT
- TOLL_NZ
- CPEX
- ECHO
- FEDEX_FR
- XDE_WEBHOOK
- TOLOS
- BORDEREXPRESS
- GIAO_HANG
- MAILPLUS_JPN
- GEODIS_ESPACE
- TNT_UK_REFR
- DOORDASH_WEBHOOK
- KEC
- CJ_HK_INTERNATIONAL
- HELTHJEM
- ZA_COURIERIT
- SFB2C
- FREIGHTQUOTE
- FR_EXAPAQ
- LANDMARK_GLOBAL_REFERENCE
- PARCEL2GO
- DELNEXT
- TCK_EXPRESS
- ENDEAVOUR_DELIVERY
- NANJINGWOYUAN
- HEPPNER_FR
- PICKRR
- FONSEN
- APC_OVERNIGHT_CONNUM
- STAR_TRACK_NEXT_FLIGHT
- UPS_FREIGHT
- DAJIN
- POSTA_PLUS
- CEVA
- ORANGE_DS
- ANSERX
- JS_EXPRESS
- PADTF
- GAC
- EZSHIP
- GEIS
- SYPOST
- AMAZON_SHIP_MCF
- SF_EX
- YUSEN
- ESP_MRW
- BRING
- PAGO
- AO_COURIER
- GBA
- DIAMOND_EUROGISTICS
- NEWEGGEXPRESS
- LALAMOVE
- SPEEDCOURIERS_GR
- CORPORATECOURIERS_WEBHOOK
- FORRUN
- PICKUP
- BOND
- ECMS
- INTELIPOST
- SK_POSTA
- FLASHEXPRESS
- FETCHR_WEBHOOK
- CN_STO
- SEKO_SFTP
- THEDELIVERYGROUP
- CELLO_SQUARE
- HOME_DELIVERY_SOLUTIONS
- DPD_HGRY
- KERRYTTC_VN
- TARRIVE
- JOYING_BOX
- COLLIVERY
- TOTAL_EXPRESS
- ZJS_EXPRESS
- STARKEN
- MAINFREIGHT
- IND_FIRSTFLIGHT
- BE_BPOST
- DEMANDSHIP
- CN_DPEX
- ACSWORLDWIDE
- LOGISTERS
- GOGLOBALPOST
- AMSTAN
- OKAYPARCEL
- I_DIKA
- ENVIALIA_REFERENCE
- PAACK_WEBHOOK
- GRAB_WEBHOOK
- PARCELPOINT
- ICUMULUS
- FDSEXPRESS
- DAIGLOBALTRACK
- CNDEXPRESS
- GLOBAL_IPARCEL
- AMAZON_FBA_SWISHIP
- WYNGS
- YURTICI_KARGO
- CN_PAYPAL_PACKAGE
- PARCEL_2_POST
- ZYLLEM
- VIA_EXPRESS
- WIZMO
- TIGFREIGHT
- PIL_LOGISTICS
- ZTO_EXPRESS
- HEPPNER
- GENERAL_OVERNIGHT
- HAPPY2POINT
- ARCO_SPEDIZIONI
- CHITCHATS
- IML
- SMOOTH
- INTEL_VALLEY
- CLE_LOGISTICS
- FIEGE
- MX_CARGO
- ZIINGFINALMILE
- TCS
- DAYTON_FREIGHT
- ROADBULL
- YODEL_DIR
- STONE3PL
- PARCELPAL_WEBHOOK
- DHL_ECOMERCE_ASA
- SIMPLYPOST
- KY_EXPRESS
- SHENZHEN
- UC_EXPRE
- US_LASERSHIP
- DIDADI
- DYNALOGIC
- DBSCHENKER_B2B
- MXE
- PFCEXPRESS
- WHISTL
- CAE_DELIVERS
- WEPOST
- ALLIEDEXPRESS
- SHIPPIT
- DDEXPRESS
- ARAMEX_AU
- TFM
- BNEED
- M_XPRESS
- HK_TGX
- LATVIJAS_PASTS
- HDB_BOX
- VIAEUROPE
- CORREO_UY
- CLEVY_LINKS
- IBEONE
- J_NET
- RCL
- 6LS
- CGS_EXPRESS
- BLR_BELPOST
- BIRDSYSTEM
- DOBROPOST
- SAP_EXPRESS
- WEASHIP
- SONICTL
- KWT
- AFLLOG_FTP
- IND_SAFEEXPRESS
- TOPHATTEREXPRESS
- SEINO
- MGLOBAL
- SZENDEX
- AVERITT
- DBSCHENKER_SV
- LEADER
- AO_DEUTSCHLAND
- 2EBOX
- EU_FLEET_SOLUTIONS
- SG_SPEEDPOST
- PCFCORP
- AERONET
- LINKBRIDGE
- DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET
- PRIMAMULTICIPTA
- ISR_POST_DOMESTIC
- COUREX
- ZAJIL_EXPRESS
- BESTWAYPARCEL
- COLLECTCO
- AEX
- JTEXPRESS
- FEDEX_UK
- USHIP
- ROUTIFIC_WEBHOOK
- GLOBAL_EXPRESS
- BRT_IT_SENDER_REF
- GLOBAVEND
- PIXSELL
- SHIPTOR
- CDEK
- VNM_VIETTELPOST
- PHL_AIR21
- PALLET_NETWORK
- CJ_CENTURY
- UK_XDP
- GSO
- VIWO
- SKYBOX
- PAPER_EXPRESS
- KERRYTJ
- NTLOGISTICS_VN
- SDH_SCM
- PALLETWAYS
- NOX_NACHTEXPRESS
- ZINC
- DPE_SOUTH_AFRC
- LOGISTIKA
- CELERITAS
- PRESSIODE
- SHREE_MARUTI
- PARCELINKLOGISTICS
- EFEX
- LOTTE
- LONESTAR
- GB_NORSK
- APRISAEXPRESS
- BEL_RS
- OSM_WORLDWIDE
- SAILPOST
- MAILAMERICAS
- WESTGATE_GL
- DTD_EXPR
- ALFATREX
- THABIT_LOGISTICS
- PROMEDDELIVERY
- PAQUETEXPRESS
- NEWZEALAND_COURIERS
- LIEFERY
- JOOM_LOGIS
- STRECK_TRANSPORT
- HCT_LOGISTICS
- ZA_FASTWAY
- CARRY_FLAP
- PONY_EXPRESS
- US_OLD_DOMINION
- ANICAM_BOX
- ALWAYS_EXPRESS
- WANBEXPRESS
- AUS_STARTRACK
- GBS_BROKER
- STALLIONEXPRESS
- RAIDEREX
- ALLJOY
- SHOPFANS
- KYUNGDONG_PARCEL
- CHAMPION_LOGISTICS
- PICKUPP_SGP
- DEALERSEND
- MORNING_EXPRESS
- NACEX
- THENILE_WEBHOOK
- JOCOM
- HOLISOL
- LBCEXPRESS_FTP
- CSE
- TFORCE_FINALMILE
- KURASI
- GEMWORLDWIDE
- SHIP_GATE
- USF_REDDAWAY
- SHIPTER
- NATIONAL_SAMEDAY
- APG
- CN_BOXC
- YUNEXPRESS
- INTEGRA2_FTP
- CAINIAO
- ECOSCOOTING
- DMS_MATRIX
- MAINWAY
- ASENDIA_USA
- PAPERFLY
- HOUNDEXPRESS
- 3JMSLOGISTICS
- EP_BOX
- BOX_BERRY
- LICCARDI_EXPRESS
- PLUS_LOG_UK
- FULFILLA
- SKY_POSTAL
- ASE
- CNWANGTONG
- PITTOHIO
- MAIL_PLUS
- XPO_LOGISTICS
- WNDIRECT
- CLOUDWISH_ASIA
- ZELERIS
- MARA_XPRESS
- GIO_EXPRESS
- OCS_WORLDWIDE
- DESTINY
- ARK_LOGISTICS
- DE_DPD_DELISTRACK
- COMET_TECH
- DHL_PARCEL_RU
- AQUILINE
- PILOT_FREIGHT
- TNT_REFR
- QWINTRY
- DANSKE_FRAGT
- SHREE_ANJANI_COURIER
- CARRIERS
- AIR_CANADA_GLOBAL
- PRESIDENT_TRANS
- STEPFORWARDFS
- ESHIPPING
- SHREETIRUPATI
- HX_EXPRESS
- INDOPAKET
- CN_17POST
- K1_EXPRESS
- CJ_GLS
- MYS_GDEX
- NATIONEX
- CN_EQUICK
- ANJUN
- VIRTRANSPORT
- FARGOOD
- SMG_EXPRESS
- RZYEXPRESS
- SEFL
- HIPSHIPPER
- HDB
- RPXLOGISTICS
- MIKROPAKKET_BE
- KUEHNE
- IT_NEXIVE
- PTS
- ETS_EXPRESS
- SWISS_POST_FTP
- COLIS_PRIVE
- FASTRK_SERV
- 4_72
- US_YRC
- CN_YUNDA
- POSTNL_INTL_3S
- AAA_COOPER
- ELIAN_POST
- CUBYN
- SAU_SAUDI_POST
- 360LION
- ABXEXPRESS_MY
- NINJAVAN_WB
- ESP_PACKLINK
- IND_JAYONEXPRESS
- GB_ARROW
- ZES_EXPRESS
- IND_GOJAVAS
- ZEPTO_EXPRESS
- SKYNET_ZA
- KPOST
- ZEEK_2_DOOR
- DHL_FREIGHT
- BLUECARE
- BLINKLASTMILE
- POSTA_UKR
- LOGISTYX_TRANSGROUP
- JINDOUYUN
- CHROBINSON
- TRACKON
- CN_POST56
- GB_TUFFNELLS
- COURANT_PLUS
- SCUDEX_EXPRESS
- SHIPENTEGRA
- TRUMPCARD
- CHOIR_EXP
- ETOTAL
- COPE
- SFPLUS_WEBHOOK
- IND_GATI
- HERMES_2MANN_HANDLING
- CN_WISHPOST
- GLOBALTRANZ
- HKD
- UDS
- BJSHOMEDELIVERY
- YAKIT
- LEXSHIP
- OMNIVA
- SUTTON
- COSTMETICSNOW
- PANTHER_REFERENCE
- SFCSERVICE
- PFLOGISTICS
- LTL
- LOOMIS_EXPRESS
- PARKNPARCEL
- SPRING_GDS
- GLS_ITALY
- ECEXPRESS
- LINE
- INTERPARCEL_AU
- GEL_EXPRESS
- AGILITY
- XL_EXPRESS
- ADERONLINE
- DIRECTCOURIERS
- PLANZER
- NOX_NIGHT_TIME_EXPRESS
- SENDING
- HUODULL
oneOf:
- type: string
enum:
- UPS
description: United Parcel
Service of America, Inc..
- type: string
enum:
- USPS
description: United States Postal Service
(USPS).
- type: string
enum:
- FEDEX
description: Federal Express.
- type: string
enum:
- AIRBORNE_EXPRESS
description: Airborne Express.
- type: string
enum:
- DHL
description: DHL Express.
- type: string
enum:
- AIRSURE
description: Airsure.
- type: string
enum:
- ROYAL_MAIL
description: Royal Mail.
- type: string
enum:
- PARCELFORCE
description: Parcel Force.
- type: string
enum:
- SWIFTAIR
description: Swift Air.
- type: string
enum:
- OTHER
description: Other.
- type: string
enum:
- UK_PARCELFORCE
description: Parcelforce UK.
- type: string
enum:
- UK_ROYALMAIL_SPECIAL
description: Royal Mail Special Delivery UK.
- type: string
enum:
- UK_ROYALMAIL_RECORDED
description: Royal Mail Recorded UK.
- type: string
enum:
- UK_ROYALMAIL_INT_SIGNED
description: Royal Mail International Signed.
- type: string
enum:
- UK_ROYALMAIL_AIRSURE
description: Royal Mail AirSure UK.
- type: string
enum:
- UK_UPS
description: United Parcel Service UK.
- type: string
enum:
- UK_FEDEX
description: Federal Express UK.
- type: string
enum:
- UK_AIRBORNE_EXPRESS
description: Airborne Express UK.
- type: string
enum:
- UK_DHL
description: DHL UK.
- type: string
enum:
- UK_OTHER
description: Other - UK.
- type: string
enum:
- UK_CANNOT_PROV_TRACK
description: Cannot provide tracking UK.
- type: string
enum:
- UK_CANNOT_PROVIDE_TRACKING
description: Cannot provide tracking - UK.
- type: string
enum:
- CA_CANADA_POST
description: Canada
Post.
- type: string
enum:
- CA_PUROLATOR
description: Purolator Canada.
- type: string
enum:
- CA_CANPAR
description: Canpar Courier Canada.
- type: string
enum:
- CA_LOOMIS
description: Loomis Express Canada.
- type: string
enum:
- CA_TNT
description: TNT Express Canada.
- type: string
enum:
- TNT
description: TNT Global.
- type: string
enum:
- CA_OTHER
description: Other - Canada.
- type: string
enum:
- CA_CANNOT_PROV_TRACK
description: Cannot provide tracking Canada.
- type: string
enum:
- DE_DP_DHL_WITHIN_EUROPE
description: DHL Parcel Europe.
- type: string
enum:
- DE_DP_DHL_T_AND_T_EXPRESS
description: DHL T and T Express.
- type: string
enum:
- DE_DHL_DP_INTL_SHIPMENTS
description: DHL DP International shipments.
- type: string
enum:
- CA_CANNOT_PROVIDE_TRACKING
description: Cannot provide tracking - Canada.
- type: string
enum:
- DE_GLS
description: General Logistics Systems (GLS)
Germany.
- type: string
enum:
- DE_DPD_DELISTACK
description: DPD Tracking Germany.
- type: string
enum:
- DE_HERMES
description: Hermes Germany.
- type: string
enum:
- DE_UPS
description: United Parcel Service Germany.
- type: string
enum:
- DE_FEDEX
description: Federal Express Germany.
- type: string
enum:
- DE_TNT
description: TNT Germany.
- type: string
enum:
- DE_OTHER
description: Other - Germany.
- type: string
enum:
- FR_CHRONOPOST
description: Chronopost France.
- type: string
enum:
- FR_COLIPOSTE
description: Coliposte France.
- type: string
enum:
- FR_DHL
description: DHL France.
- type: string
enum:
- FR_UPS
description: United Parcel Service France.
- type: string
enum:
- FR_FEDEX
description: Federal Express France.
- type: string
enum:
- FR_TNT
description: TNT France.
- type: string
enum:
- FR_GLS
description: General Logistics Systems (GLS)
France.
- type: string
enum:
- FR_OTHER
description: Other - France.
- type: string
enum:
- IT_POSTE_ITALIA
description: Poste Italia.
- type: string
enum:
- IT_DHL
description: DHL Italy.
- type: string
enum:
- IT_UPS
description: United Parcel Service Italy.
- type: string
enum:
- IT_FEDEX
description: Federal Express Italy.
- type: string
enum:
- IT_TNT
description: TNT Italy.
- type: string
enum:
- IT_GLS
description: General Logistics Systems (GLS)
Italy.
- type: string
enum:
- IT_OTHER
description: Other Italy.
- type: string
enum:
- AU_AUSTRALIA_POST_EP_PLAT
description: Australia Post EP Plat.
- type: string
enum:
- AU_AUSTRALIA_POST_EPARCEL
description: Australia Post Eparcel.
- type: string
enum:
- AU_AUSTRALIA_POST_EMS
description: Australia Post EMS.
- type: string
enum:
- AU_DHL
description: DHL Australia.
- type: string
enum:
- AU_STAR_TRACK_EXPRESS
description: StarTrack Express Australia.
- type: string
enum:
- AU_UPS
description: United Parcel Service Australia.
- type: string
enum:
- AU_FEDEX
description: Federal Express Australia.
- type: string
enum:
- AU_TNT
description: TNT Australia.
- type: string
enum:
- AU_TOLL_IPEC
description: Toll IPEC Australia.
- type: string
enum:
- AU_OTHER
description: Other - Australia.
- type: string
enum:
- FR_SUIVI
description: Suivi FedEx France.
- type: string
enum:
- IT_EBOOST_SDA
description: Poste Italiane SDA.
- type: string
enum:
- ES_CORREOS_DE_ESPANA
description: Correos de Espana.
- type: string
enum:
- ES_DHL
description: DHL Spain.
- type: string
enum:
- ES_UPS
description: United Parcel Service Spain.
- type: string
enum:
- ES_FEDEX
description: Federal Express Spain.
- type: string
enum:
- ES_TNT
description: TNT Spain.
- type: string
enum:
- ES_OTHER
description: Other - Spain.
- type: string
enum:
- AT_AUSTRIAN_POST_EMS
description: EMS Express Mail Service Austria.
- type: string
enum:
- AT_AUSTRIAN_POST_PPRIME
description: Austrian Post Prime.
- type: string
enum:
- BE_CHRONOPOST
description: Chronopost Belgium.
- type: string
enum:
- BE_TAXIPOST
description: Taxi Post.
- type: string
enum:
- CH_SWISS_POST_EXPRES
description: Swiss Post Express.
- type: string
enum:
- CH_SWISS_POST_PRIORITY
description: Swiss Post Priority.
- type: string
enum:
- CN_CHINA_POST
description: China Post.
- type: string
enum:
- HK_HONGKONG_POST
description: Hong Kong Post.
- type: string
enum:
- IE_AN_POST_SDS_EMS
description: Post SDS EMS Express Mail Service Ireland.
- type: string
enum:
- IE_AN_POST_SDS_PRIORITY
description: Post SDS Priority Ireland.
- type: string
enum:
- IE_AN_POST_REGISTERED
description: Post Registered Ireland.
- type: string
enum:
- IE_AN_POST_SWIFTPOST
description: Swift Post Ireland.
- type: string
enum:
- IN_INDIAPOST
description: India Post.
- type: string
enum:
- JP_JAPANPOST
description: Japan Post.
- type: string
enum:
- KR_KOREA_POST
description: Korea Post.
- type: string
enum:
- NL_TPG
description: TPG Post Netherlands.
- type: string
enum:
- SG_SINGPOST
description: SingPost Singapore.
- type: string
enum:
- TW_CHUNGHWA_POST
description: Chunghwa POST Taiwan.
- type: string
enum:
- CN_CHINA_POST_EMS
description: China Post EMS Express Mail Service.
- type: string
enum:
- CN_FEDEX
description: Federal Express China.
- type: string
enum:
- CN_TNT
description: TNT China.
- type: string
enum:
- CN_UPS
description: United Parcel Service China.
- type: string
enum:
- CN_OTHER
description: Other - China.
- type: string
enum:
- NL_TNT
description: TNT Netherlands.
- type: string
enum:
- NL_DHL
description: DHL Netherlands.
- type: string
enum:
- NL_UPS
description: United Parcel Service Netherlands.
- type: string
enum:
- NL_FEDEX
description: Federal Express Netherlands.
- type: string
enum:
- NL_KIALA
description: KIALA Netherlands.
- type: string
enum:
- BE_KIALA
description: Kiala Point Belgium.
- type: string
enum:
- PL_POCZTA_POLSKA
description: Poczta Polska.
- type: string
enum:
- PL_POCZTEX
description: Pocztex.
- type: string
enum:
- PL_GLS
description: General Logistics Systems Poland.
- type: string
enum:
- PL_MASTERLINK
description: Masterlink Poland.
- type: string
enum:
- PL_TNT
description: TNT Express Poland.
- type: string
enum:
- PL_DHL
description: DHL Portugal.
- type: string
enum:
- PL_UPS
description: United Parcel Service Poland.
- type: string
enum:
- PL_FEDEX
description: Federal Express Poland.
- type: string
enum:
- JP_SAGAWA_KYUU_BIN
description: Sagawa Kyuu Bin Japan.
- type: string
enum:
- JP_NITTSU_PELICAN_BIN
description: Nittsu Pelican Bin Japan.
- type: string
enum:
- JP_KURO_NEKO_YAMATO_UNYUU
description: Kuro Neko Yamato Unyuu Japan.
- type: string
enum:
- JP_TNT
description: TNT Japan.
- type: string
enum:
- JP_DHL
description: DHL Japan.
- type: string
enum:
- JP_UPS
description: United Parcel Service Japan.
- type: string
enum:
- JP_FEDEX
description: Federal Express Japan.
- type: string
enum:
- NL_PICKUP
description: Pickup Netherlands.
- type: string
enum:
- NL_INTANGIBLE
description: Intangible Netherlands.
- type: string
enum:
- NL_ABC_MAIL
description: ABC Mail Netherlands.
- type: string
enum:
- HK_FOUR_PX_EXPRESS
description: 4PX Express Hong Kong.
- type: string
enum:
- HK_FLYT_EXPRESS
description: Flyt Express Hong Kong.
- type: string
enum:
- US_ASCENDIA
description: Ascendia US.
- type: string
enum:
- US_ENSENDA
description: Ensenda US.
- type: string
enum:
- US_GLOBEGISTICS
description: Globeistics US.
- type: string
enum:
- US_ONTRAC
description: Ontrac US.
- type: string
enum:
- RRDONNELLEY
description: RR Donnelley.
- type: string
enum:
- ASENDIA_UK
description: Asendia UK.
- type: string
enum:
- UK_COLLECTPLUS
description: CollectPlus UK.
- type: string
enum:
- UK_DPD
description: DPD UK.
- type: string
enum:
- UK_HERMESWORLD
description: Hermesworld UK.
- type: string
enum:
- UK_INTERLINK_EXPRESS
description: Interlink Express UK.
- type: string
enum:
- UK_TNT
description: TNT UK.
- type: string
enum:
- UK_UK_MAIL
description: UK Mail.
- type: string
enum:
- UK_YODEL
description: Yodel UK.
- type: string
enum:
- BUYLOGIC
description: Buylogic.
- type: string
enum:
- CN_EMS
description: EMS China.
- type: string
enum:
- CHINA_POST
description: China Post.
- type: string
enum:
- CNEXPS
description: CN Express China.
- type: string
enum:
- CPACKET
description: Cpacket.
- type: string
enum:
- CUCKOOEXPRESS
description: Cuckoo Express.
- type: string
enum:
- CN_EC
description: EC China.
- type: string
enum:
- CN_EMPS
description: EMPS China.
- type: string
enum:
- DE_ASENDIA
description: Asendia Germany.
- type: string
enum:
- UK_DELTEC
description: Deltec UK.
- type: string
enum:
- DE_DEUTSCHE
description: Deutsche Germany.
- type: string
enum:
- DE_DPD
description: DPD Germany.
- type: string
enum:
- RABEN_GROUP
description: Raben Group.
- type: string
enum:
- GLOBAL_TNT
description: TNT Global.
- type: string
enum:
- ADSONE
description: ADSone Cumulus.
- type: string
enum:
- AU_AU_POST
description: Australian Postal
Corporation.
- type: string
enum:
- BONDSCOURIERS
description: Bonds Couriers.
- type: string
enum:
- COURIERS_PLEASE
description: Couriers Please.
- type: string
enum:
- DTDC_AU
description: DTDC Australia.
- type: string
enum:
- AU_FASTWAY
description: Fastway Australia.
- type: string
enum:
- HUNTER_EXPRESS
description: Hunter Express.
- type: string
enum:
- SENDLE
description: Sendle.
- type: string
enum:
- AUS_TOLL
description: Toll Australia.
- type: string
enum:
- TOLL
description: Toll.
- type: string
enum:
- UBI_LOGISTICS
description: UBI Logistics.
- type: string
enum:
- OMNIPARCEL
description: Omni Parcel.
- type: string
enum:
- QUANTIUM
description: Quantium.
- type: string
enum:
- CN_SF_EXPRESS
description: SF Express China.
- type: string
enum:
- SEKOLOGISTICS
description: Seko Logistics.
- type: string
enum:
- HK_TAQBIN
description: TA-Q-BIN Parcel Hong Kong.
- type: string
enum:
- GB_APC
description: APC Overnight UK.
- type: string
enum:
- CA_CANPAR_COURIER
description: Canpar Courier Canada.
- type: string
enum:
- GLOBAL_ESTES
description: Estes Global.
- type: string
enum:
- CA_GREYHOUND
description: Greyhound Canada.
- type: string
enum:
- PUROLATOR
description: Purolator.
- type: string
enum:
- US_RL
description: RL US.
- type: string
enum:
- IT_BRT
description: BRT
Corriere Espresso Italy.
- type: string
enum:
- DMM_NETWORK
description: DMM Network.
- type: string
enum:
- IT_FERCAM
description: Fercam Italy.
- type: string
enum:
- HERMES_IT
description: Hermes Italy.
- type: string
enum:
- IT_POSTE_ITALIANE
description: Poste Italiane.
- type: string
enum:
- IT_SDA
description: SDA Express Courier.
- type: string
enum:
- IT_SGT
description: SGT Corriere Espresso Italy.
- type: string
enum:
- GLOBAL_SKYNET
description: Skynet Global.
- type: string
enum:
- FR_BERT
description: Bert France.
- type: string
enum:
- FR_COLIS
description: Colis France.
- type: string
enum:
- FR_GEODIS
description: Geodis France.
- type: string
enum:
- FR_LAPOSTE
description: Laposte France.
- type: string
enum:
- FR_TELIWAY
description: Teliway France.
- type: string
enum:
- DPD_POLAND
description: DPD Poland.
- type: string
enum:
- INPOST_PACZKOMATY
description: InPost Paczkomaty.
- type: string
enum:
- POL_POCZTA
description: Poczta Poland.
- type: string
enum:
- POL_SIODEMKA
description: Siodemka Poland.
- type: string
enum:
- ESP_CORREOS
description: Sociedad
Estatal Correos y Telégrafos.
- type: string
enum:
- ES_CORREOS
description: Sociedad
Estatal Correos y Telégrafos.
- type: string
enum:
- ESP_NACEX
description: Nacex
Spain.
- type: string
enum:
- ESP_ASM
description: Parcel Monitor
Spain.
- type: string
enum:
- ESP_REDUR
description: Redur Spain.
- type: string
enum:
- CBL_LOGISTICA
description: CBL Logística.
- type: string
enum:
- EKART
description: Ekart.
- type: string
enum:
- IND_DELHIVERY
description: Delhivery India.
- type: string
enum:
- IND_BLUEDART
description: Blue Dart Express DHL.
- type: string
enum:
- IND_DTDC
description: DTDC India.
- type: string
enum:
- IND_PROFESSIONAL_COURIERS
description: Professional Couriers India.
- type: string
enum:
- IND_REDEXPRESS
description: Red Express India.
- type: string
enum:
- IND_XPRESSBEES
description: XpressBees India.
- type: string
enum:
- IND_DOTZOT
description: DotZot India.
- type: string
enum:
- THA_KERRY
description: Kerry Thailand.
- type: string
enum:
- SENDIT
description: SendIt.
- type: string
enum:
- ACOMMERCE
description: aCommerce.
- type: string
enum:
- NINJAVAN_THAI
description: Ninjavan Thailand.
- type: string
enum:
- NIM_EXPRESS
description: Nim Express.
- type: string
enum:
- THA_THAILAND_POST
description: Thailand Post.
- type: string
enum:
- THA_DYNAMIC_LOGISTICS
description: Dynamic Logistics Thailand.
- type: string
enum:
- ALPHAFAST
description: Alphafast.
- type: string
enum:
- FASTRAK_TH
description: Fastrak Thailand.
- type: string
enum:
- EPARCEL_KR
description: EParcel Korea.
- type: string
enum:
- CJ_KOREA_THAI
description: CJ Logistics
in Thailand.
- type: string
enum:
- RINCOS
description: Rincos.
- type: string
enum:
- KOR_KOREA_POST
description: Korea Post.
- type: string
enum:
- KOR_CJ
description: CJ Korea.
- type: string
enum:
- KOR_ECARGO
description: Ecargo Korea.
- type: string
enum:
- SREKOREA
description: SRE Korea.
- type: string
enum:
- ROCKETPARCEL
description: Rocket Parcel
International.
- type: string
enum:
- BG_BULGARIAN_POST
description: Bulgarian Post.
- type: string
enum:
- JPN_JAPAN_POST
description: Japan
Post.
- type: string
enum:
- JPN_YAMATO
description: Yamato Japan.
- type: string
enum:
- JPN_SAGAWA
description: Sagawa Japan.
- type: string
enum:
- TUR_PTT
description: PTT Turkey.
- type: string
enum:
- AUT_AUSTRIAN_POST
description: Austrian Post.
- type: string
enum:
- AU_AUSTRIAN_POST
description: Austrian Post.
- type: string
enum:
- RUSSIAN_POST
description: Russian Post.
- type: string
enum:
- BEL_DHL
description: DHL Belgium.
- type: string
enum:
- FR_MONDIAL
description: Mondial France.
- type: string
enum:
- EU_BPOST
description: bpost.
- type: string
enum:
- LANDMARK_GLOBAL
description: Landmark Global.
- type: string
enum:
- IDN_POS
description: Indonesia Post.
- type: string
enum:
- IDN_POS_INT
description: Indonesia Post International.
- type: string
enum:
- IDN_JNE
description: JNE Indonesia.
- type: string
enum:
- IDN_PANDU
description: Pandu Indonesia.
- type: string
enum:
- RPX
description: RPX International.
- type: string
enum:
- IDN_TIKI
description: Tiki Indonesia.
- type: string
enum:
- IDN_LION_PARCEL
description: Lion Parcel Indonesia.
- type: string
enum:
- NINJAVAN_ID
description: Ninjavan Indonesia.
- type: string
enum:
- IDN_WAHANA
description: Wahana Indonesia.
- type: string
enum:
- IDN_FIRST_LOGISTICS
description: First Logistics Indonesia.
- type: string
enum:
- UK_AN_POST
description: AddressPay UK.
- type: string
enum:
- DPD
description: DPD Global.
- type: string
enum:
- UK_FASTWAY
description: Fastway UK.
- type: string
enum:
- UK_NIGHTLINE
description: Nightline UK.
- type: string
enum:
- WISELOADS
description: Wiseloads.
- type: string
enum:
- GR_ELTA
description: Elta Greece.
- type: string
enum:
- GRC_ACS
description: ACS Greece.
- type: string
enum:
- GR_GENIKI
description: Geniki Greece.
- type: string
enum:
- NINJAVAN_PHILIPPINES
description: Ninja Van Philippines.
- type: string
enum:
- PHL_XEND_EXPRESS
description: Xend Express Philippines.
- type: string
enum:
- PHL_LBC
description: LBC Philippines.
- type: string
enum:
- PHL_JAMEXPRESS
description: JamExpress Philippines.
- type: string
enum:
- PHL_AIRSPEED
description: Airspeed Philippines.
- type: string
enum:
- PHL_RAF
description: RAF Philippines.
- type: string
enum:
- DIRECTLOG
description: Directlog.
- type: string
enum:
- BRA_CORREIOS
description: Correios Brazil.
- type: string
enum:
- NLD_DHL
description: DHL Netherlands.
- type: string
enum:
- NLD_POSTNL
description: PostNL Netherlands.
- type: string
enum:
- NLD_GLS
description: General Logistics Systems (GLS)
Netherlands.
- type: string
enum:
- NLD_TRANSMISSION
description: Transmission Netherlands.
- type: string
enum:
- CORREOS_DE_MEXICO
description: Mex
Post Correos de Mexico.
- type: string
enum:
- MEX_ESTAFETA
description: Estafeta Mexico.
- type: string
enum:
- MEX_SENDA
description: Senda Mexico.
- type: string
enum:
- MEX_REDPACK
description: Redpack Mexico.
- type: string
enum:
- MEX_AEROFLASH
description: Aeroflash Mexico.
- type: string
enum:
- NATIONWIDE_MY
description: Nationwide Malaysia.
- type: string
enum:
- MYS_MYS_POST
description: Pos Malaysia.
- type: string
enum:
- MYS_TAQBIN
description: TA-Q-BIN Parcel Malaysia.
- type: string
enum:
- MYS_SKYNET
description: Skynet Malaysia.
- type: string
enum:
- MYS_CITYLINK
description: Citylink Malaysia.
- type: string
enum:
- MYS_AIRPAK
description: Airpak Malaysia.
- type: string
enum:
- NINJAVAN_MY
description: Ninjavan Malaysia.
- type: string
enum:
- KANGAROO_MY
description: Kangaroo Express Malaysia.
- type: string
enum:
- VNM_VIETNAM_POST
description: Vietnam Post.
- type: string
enum:
- VNPOST_EMS
description: Post EMS Vietnam.
- type: string
enum:
- PRT_INT_SEUR
description: Internationational Seur
Portugal.
- type: string
enum:
- PRT_CTT
description: CTT Expresso
Portugal.
- type: string
enum:
- PRT_CHRONOPOST
description: Chronopost Portugal.
- type: string
enum:
- PRT_SEUR
description: Seur Portugal.
- type: string
enum:
- ADICIONAL
description: Adicional.
- type: string
enum:
- LTU_LIETUVOS
description: Lietuvos paštas Lithuania.
- type: string
enum:
- DPEX
description: DPEX Worldwide.
- type: string
enum:
- LWE_HK
description: LWE Hong Kong.
- type: string
enum:
- SG_SG_POST
description: Singapore Post.
- type: string
enum:
- SG_TAQBIN
description: TA-Q-BIN Parcel Singapore.
- type: string
enum:
- SG_NINJAVAN
description: Ninjavan Singapore.
- type: string
enum:
- SG_ZALORA
description: Zalora Singapore.
- type: string
enum:
- JET_SHIP
description: Jetship.
- type: string
enum:
- SG_PARCELPOST
description: Parcel Post Singapore.
- type: string
enum:
- CHE_SWISS_POST
description: Swiss Post.
- type: string
enum:
- ASENDIA_HK
description: Asendia Hong Kong.
- type: string
enum:
- HUN_MAGYAR
description: Magyar Posta.
- type: string
enum:
- POSTNORD_LOGISTICS
description: Post Nord Logistics.
- type: string
enum:
- SWE_DIRECTLINK
description: Direct Link Sweden.
- type: string
enum:
- SWE_POSTNORD
description: PostNord Sverige.
- type: string
enum:
- SWE_DB
description: DB Schenker Sweden.
- type: string
enum:
- CZE_CESKA
description: Česká pošta.
- type: string
enum:
- NZ_NZ_POST
description: New Zealand Post
Limited (NZ).
- type: string
enum:
- NZ_COURIER_POST
description: CourierPost
New Zealand.
- type: string
enum:
- FASTWAY_NZ
description: Fastway New Zealand.
- type: string
enum:
- TW_TAIWAN_POST
description: Chunghwa
Post.
- type: string
enum:
- SPREADEL
description: Spreadel.
- type: string
enum:
- ARE_EMIRATES_POST
description: Emirates Post
Group.
- type: string
enum:
- AXL
description: AXL Express & Logistics.
- type: string
enum:
- CYP_CYPRUS_POST
description: Cyprus Post.
- type: string
enum:
- HRV_HRVATSKA
description: Hrvatska Pošta.
- type: string
enum:
- NOR_POSTEN
description: Posten Norge.
- type: string
enum:
- RAM
description: JP
RAM Shipping.
- type: string
enum:
- THECOURIERGUY
description: The Courier Guy.
- type: string
enum:
- ZA_FASTWAY
description: fastway New Zealand
- type: string
enum:
- DPE_EXPRESS
description: DPE Express.
- type: string
enum:
- POSTI
description: Posti.
- type: string
enum:
- MATKAHUOLTO
description: Matkahuoloto.
- type: string
enum:
- GLOBAL_DHL
description: DHL Global.
- type: string
enum:
- ARG_CORREO
description: Correo Argentino.
- type: string
enum:
- ARG_OCA
description: OCA Argentia.
- type: string
enum:
- POST_SERBIA
description: Post of Serbia.
- type: string
enum:
- BH_POSTA
description: BH POŠTA.
- type: string
enum:
- CORREOS_CHILE
description: CorreosChile.
- type: string
enum:
- APR_72
description: APR 72.
- type: string
enum:
- CORREOS_DE_COSTA_RICA
description: Correos de Costa Rica.
- type: string
enum:
- POSTUR_IS
description: Postur.
- type: string
enum:
- SPEEDEXCOURIER
description: Speedex Courier.
- type: string
enum:
- ROU_POSTA
description: Poșta Română.
- type: string
enum:
- UKR_NOVA
description: Nova Poshta.
- type: string
enum:
- UKR_POSHTA
description: Ukrposhta
- Ukraine's National Post.
- type: string
enum:
- NGA_NIPOST
description: Nigerian Postal Service.
- type: string
enum:
- NG_COURIERPLUS
description: Courier Plus Nigeria.
- type: string
enum:
- ESHOPWORLD
description: EShopWorld.
- type: string
enum:
- WEBINTERPRET
description: WebInterpret.
- type: string
enum:
- HERMES
description: Hermes.
- type: string
enum:
- ABC_MAIL
description: ABC Mail.
- type: string
enum:
- ARAMEX
description: Aramex.
- type: string
enum:
- YANWEN
description: Yanwen Express.
- type: string
enum:
- INTERNATIONAL_BRIDGE
description: International Bridge.
- type: string
enum:
- SFC_LOGISTICS
description: SFC Logistics.
- type: string
enum:
- BQC_EXPRESS
description: BQC Express.
- type: string
enum:
- ONE_WORLD
description: One World.
- type: string
enum:
- IT_REGISTER_MAIL
description: Registered Mail Italy.
- type: string
enum:
- WINIT
description: WinIt.
- type: string
enum:
- CONTINENTAL
description: Continental.
- type: string
enum:
- EFS
description: Enterprise Freight Systems
(EFS).
- type: string
enum:
- PANTOS
description: Pantos.
- type: string
enum:
- RELAIS_COLIS
description: Relais Colis.
- type: string
enum:
- US_DHL_EXPRESS
description: DHL Express US.
- type: string
enum:
- US_DHL_PARCEL
description: DHL Parcel US.
- type: string
enum:
- US_DHL_ECOMMERCE
description: DHL
eCommerce US.
- type: string
enum:
- US_DHL_GLOBALFORWARDING
description: DHL Global Forwarding US.
- type: string
enum:
- UK_DHL_EXPRESS
description: DHL Express UK.
- type: string
enum:
- UK_DHL_PARCEL
description: DHL Parcel UK.
- type: string
enum:
- UK_DHL_GLOBALFORWARDING
description: DHL Global Forwarding UK.
- type: string
enum:
- CN_DHL_EXPRESS
description: DHL Express Canada.
- type: string
enum:
- CN_DHL_ECOMMERCE
description: DHL eCommerce China.
- type: string
enum:
- CN_DHL_GLOBALFORWARDING
description: DHL Global Forwarding China.
- type: string
enum:
- DE_DHL_EXPRESS
description: DHL Express Germany.
- type: string
enum:
- DE_DHL_PARCEL
description: DHL Parcel Germany.
- type: string
enum:
- DE_DHL_PACKET
description: DHL Packet Germany.
- type: string
enum:
- DE_DHL_ECOMMERCE
description: DHL eCommerce Germany.
- type: string
enum:
- DE_DHL_GLOBALFORWARDING
description: DHL Global Forwarding Germany.
- type: string
enum:
- DE_DHL_DEUTSCHEPOST
description: DHL Deutschepost Germany.
- type: string
enum:
- AU_DHL_EXPRESS
description: DHL Express Australia.
- type: string
enum:
- AU_DHL_ECOMMERCE
description: DHL eCommerce Australia.
- type: string
enum:
- AU_DHL_GLOBALFORWARDING
description: DHL Global Forwarding Australia.
- type: string
enum:
- HK_DHL_EXPRESS
description: DHL Express Hong Kong.
- type: string
enum:
- HK_DHL_ECOMMERCE
description: DHL eCommerce Hong Kong.
- type: string
enum:
- HK_DHL_GLOBALFORWARDING
description: DHL Global Forwarding Hong Kong.
- type: string
enum:
- CA_DHL_EXPRESS
description: DHL Express Canada.
- type: string
enum:
- CA_DHL_ECOMMERCE
description: DHL eCommerce Canada.
- type: string
enum:
- CA_DHL_GLOBALFORWARDING
description: DHL Global Forwarding Canada.
- type: string
enum:
- IT_DHL_EXPRESS
description: DHL Express Italy.
- type: string
enum:
- IT_DHL_ECOMMERCE
description: DHL eCommerce Italy.
- type: string
enum:
- IT_DHL_GLOBALFORWARDING
description: DHL Global Forwarding Italy.
- type: string
enum:
- FR_DHL_EXPRESS
description: DHL Express France.
- type: string
enum:
- FR_DHL_PARCEL
description: DHL Parcel France.
- type: string
enum:
- FR_DHL_GLOBALFORWARDING
description: DHL Global Forwarding France.
- type: string
enum:
- PL_DHL_EXPRESS
description: DHL Express Poland.
- type: string
enum:
- PL_DHL_PARCEL
description: DHL Parcel Poland.
- type: string
enum:
- PL_DHL_GLOBALFORWARDING
description: DHL
Global Forwarding Poland
- type: string
enum:
- ABC_PACKAGE
description: ABC Package Express.
- type: string
enum:
- AN_POST
description: An Post Ireland.
- type: string
enum:
- APC_OVERNIGHT
description: APC Overnight.
- type: string
enum:
- ASM_ES
description: ASM Tracking
Spain.
- type: string
enum:
- AUPOST_CN
description: Logistics
in China.
- type: string
enum:
- ACOMMMERCE
description: aCommerce.
- type: string
enum:
- ADICIONAL_PT
description: Adicional
Logistics Portugal.
- type: string
enum:
- AIR_21
description: Air 21.
- type: string
enum:
- AIRBORNE_EXPRESS_UK
description: Airborne Express UK.
- type: string
enum:
- AIRPAK_MY
description: Airpak Malaysia.
- type: string
enum:
- AIRSPEED
description: Airspeed.
- type: string
enum:
- ASENDIA_DE
description: Asendia Germany.
- type: string
enum:
- ASENDIA_US
description: Asendia USA.
- type: string
enum:
- AUSTRALIA_POST
description: Australia Post.
- type: string
enum:
- TOLL_AU
description: Toll Australia.
- type: string
enum:
- AUSTRIAN_POST_EXPRESS
description: Austrian Post Express.
- type: string
enum:
- AUSTRIAN_POST
description: Austrian Post Registered.
- type: string
enum:
- B_TWO_C_EUROPE
description: B2C Europe.
- type: string
enum:
- BERT
description: Groupe Bert.
- type: string
enum:
- BPOST
description: BPost.
- type: string
enum:
- BRT_IT
description: BRT Bartolini.
- type: string
enum:
- BLUEDART
description: Bluedart.
- type: string
enum:
- BONDS_COURIERS
description: Bonds Couriers.
- type: string
enum:
- BPOST_INT
description: bpost International.
- type: string
enum:
- BULGARIAN_POST
description: Bulgarian Post.
- type: string
enum:
- CJ_LOGISTICS
description: CJ Logistics.
- type: string
enum:
- CJ_INT_MY
description: CJ Malaysia International.
- type: string
enum:
- CJ_MY
description: CJ Malaysia.
- type: string
enum:
- CJ_TH
description: CJ Thailand.
- type: string
enum:
- CANADA_POST
description: Canada Post.
- type: string
enum:
- CANPAR
description: Canpar Express.
- type: string
enum:
- CESKA_CZ
description: Česká
Pošta.
- type: string
enum:
- CHRONOPOST_FR
description: Chronopost
France.
- type: string
enum:
- CHRONOPOST_PT
description: Chronopost
Portugal.
- type: string
enum:
- CHUNGHWA_POST
description: Chunghwa Post.
- type: string
enum:
- CITYLINK_MY
description: CityLink Malaysia.
- type: string
enum:
- COLIPOSTE
description: Coliposte.
- type: string
enum:
- COLIS
description: Colis France.
- type: string
enum:
- COLLECTPLUS
description: CollectPlus.
- type: string
enum:
- CORREOS_AG
description: Correos Argentina.
- type: string
enum:
- CORREOS_BR
description: Correos Brazil.
- type: string
enum:
- CORREOS_CL
description: Correos Chile.
- type: string
enum:
- CORREOS_CR
description: Correos De Costa Rica.
- type: string
enum:
- CORREOS_MX
description: Correos De Mexico.
- type: string
enum:
- CORREOS_ES
description: Correos De Spain.
- type: string
enum:
- CORREOS_EXPRESS
description: Correos Express.
- type: string
enum:
- COURIERPLUS
description: Courier Plus.
- type: string
enum:
- COURIER_POST
description: Courier Post.
- type: string
enum:
- CYPRUS_POST_CYP
description: Cyprus Post.
- type: string
enum:
- DBSCHENKER_SE
description: DB Schenker Sweden.
- type: string
enum:
- DHL_ES
description: DHL Spain.
- type: string
enum:
- DHL_ACTIVE_TRACING
description: DHL Active Tracing.
- type: string
enum:
- DHL_AU
description: DHL Australia.
- type: string
enum:
- DHL_BENELUX
description: DHL Benelux.
- type: string
enum:
- DHL_DEUTSCHE_POST
description: DHL Deutsche Post.
- type: string
enum:
- DHL_FR
description: DHL France.
- type: string
enum:
- DHL_GLOBAL_ECOMMERCE
description: DHL Global eCommerce.
- type: string
enum:
- DHL_HK
description: DHL HonKong
- type: string
enum:
- DHL_IT
description: DHL Italy.
- type: string
enum:
- DHL_JP
description: DHL Japan.
- type: string
enum:
- DHL_NL
description: DHL Netherlands.
- type: string
enum:
- DHL_PACKET
description: DHL Packet.
- type: string
enum:
- DHL_PARCEL_NL
description: DHL Parcel Netherlands.
- type: string
enum:
- DHL_PARCEL_ES
description: DHL Parcel Spain.
- type: string
enum:
- DHL_PL
description: DHL Poland.
- type: string
enum:
- DHL_SG
description: DHL Singapore.
- type: string
enum:
- DHL_UK
description: DHL UK.
- type: string
enum:
- DHL_GLOBAL_MAIL_ASIA
description: DHL eCommerce Asia.
- type: string
enum:
- DHL_GLOBAL_MAIL
description: DHL eCommerce US.
- type: string
enum:
- DHL_AT
description: DHL Austria.
- type: string
enum:
- DPD_DELISTRACK
description: DPD Delistrack.
- type: string
enum:
- DPD_FR
description: DPD France.
- type: string
enum:
- DPD_DE
description: DPD Germany.
- type: string
enum:
- DPD_HK
description: DPD Hong Kong.
- type: string
enum:
- DPD_IR
description: DPD Ireland.
- type: string
enum:
- DPD_LOCAL_REF
description: DPD Local Reference.
- type: string
enum:
- DPD_LOCAL
description: DPD Local.
- type: string
enum:
- DPD_PL
description: DPD Poland.
- type: string
enum:
- DPD_RO
description: DPD Romania.
- type: string
enum:
- DPD_RU
description: DPD Russia.
- type: string
enum:
- DPD_UK
description: DPD UK.
- type: string
enum:
- DTDC_EXPRESS
description: DTDC Express Global.
- type: string
enum:
- DTDC_IN
description: DTDC India.
- type: string
enum:
- DAWN_WING
description: Dawn Wing.
- type: string
enum:
- DELHIVERY_IN
description: Delhivery India.
- type: string
enum:
- DELTEC_DE
description: Deltec Germany.
- type: string
enum:
- DELTEC_UK
description: Deltec UK.
- type: string
enum:
- DEUTSCHE_DE
description: Deutsche
Post.
- type: string
enum:
- DIRECTLINK_SE
description: Direct Link Sweden.
- type: string
enum:
- DIRECTLOG_BR
description: Directlog.
- type: string
enum:
- DOTZOT
description: Dotzot.
- type: string
enum:
- EC_CN
description: EC China.
- type: string
enum:
- ELTA_GR
description: ELTA Greece.
- type: string
enum:
- EMPS_CN
description: EMPS China.
- type: string
enum:
- EMS_CN
description: EMS China.
- type: string
enum:
- ECARGO
description: Ecargo.
- type: string
enum:
- EMIRATES_POST
description: Emirates Post.
- type: string
enum:
- ENSENDA
description: Ensenda USA.
- type: string
enum:
- ESTAFETA
description: Estafeta.
- type: string
enum:
- ESTES
description: Estes.
- type: string
enum:
- FERCAM_IT
description: FERCAM Logistics & Transport.
- type: string
enum:
- FLYT_EXPRESS
description: FLYT Express.
- type: string
enum:
- FASTRACK
description: FastTrack Thailand.
- type: string
enum:
- FASTWAY_US
description: Fastway USA.
- type: string
enum:
- FASTWAY_ZA
description: Fastway South Africa.
- type: string
enum:
- FASTWAY_UK
description: Fastway UK.
- type: string
enum:
- FASTWAY_AU
description: Fastway Australia.
- type: string
enum:
- FIRST_LOGISITCS
description: First Logistics.
- type: string
enum:
- FOUR_PX_EXPRESS
description: 4PX Express.
- type: string
enum:
- GEODIS
description: GEODIS - Distribution & Express.
- type: string
enum:
- GLS_CZ
description: GLS Czech Republic.
- type: string
enum:
- GLS_FR
description: GLS France.
- type: string
enum:
- GLS_DE
description: GLS Germany.
- type: string
enum:
- GLS_IT
description: GLS Italy.
- type: string
enum:
- GLS_NL
description: GLS Netherlands.
- type: string
enum:
- GLS_ES
description: GLS Spain.
- type: string
enum:
- GLS
description: GLS.
- type: string
enum:
- ACS_GR
description: Parcel
Monitor Greece.
- type: string
enum:
- GENIKI_GR
description: Geniki Greece.
- type: string
enum:
- GLOBEGISTICS
description: Globegistics USA.
- type: string
enum:
- GREYHOUND
description: Greyhound.
- type: string
enum:
- HERMES_DE
description: Hermes Germany.
- type: string
enum:
- HERMESWORLD_UK
description: HermesWorld UK.
- type: string
enum:
- HK_POST
description: Hong Kong Post.
- type: string
enum:
- HRVATSKA_HR
description: Hrvatska Pošta.
- type: string
enum:
- HUAHAN_EXPRESS
description: Huahan Express.
- type: string
enum:
- IMX
description: IMX France.
- type: string
enum:
- ITIS
description: ITIS
International Courier Tracking.
- type: string
enum:
- INDIA_POST
description: India Post.
- type: string
enum:
- INTERLINK
description: Interlink Express.
- type: string
enum:
- INT_SEUR
description: International Seur.
- type: string
enum:
- INT_SUER
description: International Seur.
- type: string
enum:
- ISRAEL_POST
description: Israel Post.
- type: string
enum:
- JNE_IDN
description: JNE Indonesia.
- type: string
enum:
- JAMEXPRESS_PH
description: Jam Express.
- type: string
enum:
- JAPAN_POST
description: Japan Post.
- type: string
enum:
- JP_POST
description: Japan Post.
- type: string
enum:
- JETSHIP_MY
description: Jet Ship Malaysia.
- type: string
enum:
- JETSHIP_SG
description: JetShip Singapore.
- type: string
enum:
- KERRY_EXPRESS_VN
description: Kerry Express Vietnam.
- type: string
enum:
- KERRY_EXPRESS_HK
description: Kerry Express Hong Kong.
- type: string
enum:
- KERRY_EXPRESS_TH
description: Kerry Express Thailand.
- type: string
enum:
- KIALA
description: Kiala.
- type: string
enum:
- KOREA_POST
description: Korea Post.
- type: string
enum:
- CJ_KR
description: CJ Logistics
Korea.
- type: string
enum:
- LAPOSTE
description: LA Poste.
- type: string
enum:
- LBC_PH
description: LBC Express.
- type: string
enum:
- LIETUVOS_LT
description: Lietuvos Pastas.
- type: string
enum:
- LION_PARCEL
description: Lion Parcel.
- type: string
enum:
- LOGISTICSWORLDWIDE_HK
description: Logistics Worldwide
Hong Kong.
- type: string
enum:
- LOGISTICSWORLDWIDE_KR
description: Logistics Worldwide
Korea.
- type: string
enum:
- LOGISTICSWORLDWIDE_MY
description: Logistics Worldwide
Malaysia.
- type: string
enum:
- LOOMIS
description: Loomis.
- type: string
enum:
- MONDIAL
description: Mondial Relay.
- type: string
enum:
- MAGYAR_HU
description: Magyar
Posta.
- type: string
enum:
- MALAYSIA_POST
description: Pos Malaysia Berhad.
- type: string
enum:
- MASTERLINK
description: Masterlink.
- type: string
enum:
- AEROFLASH
description: Mexico Aeroflash.
- type: string
enum:
- REDPACK
description: Mexico Redpack.
- type: string
enum:
- SENDA_MX
description: Mexico Senda Express.
- type: string
enum:
- MONDIAL_BE
description: Mondial Belgium.
- type: string
enum:
- MYHERMES
description: MyHermes UK.
- type: string
enum:
- NACEX_ES
description: Nacex
Spain.
- type: string
enum:
- NATIONWIDE
description: Nationwide
Carrier and Logistics Services.
- type: string
enum:
- NZ_POST
description: New Zealand Post.
- type: string
enum:
- NIPOST_NG
description: Nigerian Postal Service.
- type: string
enum:
- NIGHTLINE_UK
description: Nightline UK.
- type: string
enum:
- NINJAVAN_PH
description: Ninjavan Philippines.
- type: string
enum:
- NINJAVAN_SG
description: Ninjavan Singapore.
- type: string
enum:
- NOVA_POSHTA_INT
description: Nova Poshta International.
- type: string
enum:
- NOVA_POSHTA
description: Nova Poshta.
- type: string
enum:
- OCA_AR
description: OCA Argentina.
- type: string
enum:
- ONTRAC
description: OnTrac.
- type: string
enum:
- PTT_POST
description: PTT Posta.
- type: string
enum:
- PANDU
description: Pandu Logistics.
- type: string
enum:
- PARCELPOST_SG
description: Parcel Post Singapore.
- type: string
enum:
- POCZTA_POLSKA
description: Poczta Polska.
- type: string
enum:
- POCZTEX
description: Pocztex.
- type: string
enum:
- CTT_PT
description: CTT Expresso
Portugal.
- type: string
enum:
- SEUR_PT
description: Seur Portugal.
- type: string
enum:
- POS_ID
description: Pos Indonesia Domestic.
- type: string
enum:
- POS_INT
description: Pos Indonesia International.
- type: string
enum:
- POSTNL_INT_3_S
description: Koninklijke PostNL.
- type: string
enum:
- POSTNL
description: PostNL.
- type: string
enum:
- POSTNL_INT
description: PostNl International.
- type: string
enum:
- POSTNORD_LOGISTICS_DK
description: PostNord Logistics Denmark.
- type: string
enum:
- POSTNORD_LOGISTICS_SE
description: PostNord Logistics Sweden.
- type: string
enum:
- POSTNORD_LOGISTICS_GLOBAL
description: PostNord Logistics.
- type: string
enum:
- POSTA_RO
description: Posta Romana.
- type: string
enum:
- POSTE_ITALIANE
description: Poste Italiane.
- type: string
enum:
- POSTEN_NORGE
description: Posten Norge.
- type: string
enum:
- PROFESSIONAL_COURIERS
description: Professional Couriers.
- type: string
enum:
- RAF_PH
description: RAF Philippines.
- type: string
enum:
- RL_US
description: RL Carriers.
- type: string
enum:
- RPD_2_MAN
description: RPD2man Deliveries.
- type: string
enum:
- RPX_ID
description: RPX Indonesia.
- type: string
enum:
- REDEXPRESS
description: Red Express.
- type: string
enum:
- REDUR_ES
description: Redur Spain.
- type: string
enum:
- REGISTER_MAIL_IT
description: Registered Mail Italy.
- type: string
enum:
- RELAIS_COLIS_FR
description: Relais Colis.
- type: string
enum:
- ROCKET_PARCEL
description: Rocket Parcel International.
- type: string
enum:
- SDA_IT
description: SDA Italy.
- type: string
enum:
- SF_EXPRESS
description: SF Express.
- type: string
enum:
- SFC_EXPRESS
description: SFC Express.
- type: string
enum:
- SGT_IT
description: SGT Corriere Espresso.
- type: string
enum:
- SRE_KOREA
description: SRE Korea.
- type: string
enum:
- SAGAWA
description: Sagawa.
- type: string
enum:
- SAGAWA_JP
description: Sagawa.
- type: string
enum:
- POST_SERBIA_CS
description: Serbia Post.
- type: string
enum:
- SINGPOST
description: Singapore Post.
- type: string
enum:
- SIODEMKA
description: Siodemka.
- type: string
enum:
- SKYNET_WORLDWIDE
description: SkyNet Worldwide
Express.
- type: string
enum:
- SKYNET_MY
description: Skynet Malaysia.
- type: string
enum:
- SKYNET_UAE
description: SkyNet Worldwide Express
Dubai, UAE.
- type: string
enum:
- SKYNET_UK
description: SkyNet Worldwide Express
UK.
- type: string
enum:
- SEUR_ES
description: Seur Spain.
- type: string
enum:
- STARTRACK_EXPRESS
description: Star Track Express.
- type: string
enum:
- STARTRACK
description: Star Track.
- type: string
enum:
- SWISS_POST
description: Swiss Post.
- type: string
enum:
- TNT_AU
description: TNT Australia.
- type: string
enum:
- TNT_CN
description: TNT China.
- type: string
enum:
- TNT_CLICK_IT
description: TNT Click Italy.
- type: string
enum:
- TNT_FR
description: TNT France.
- type: string
enum:
- TNT_DE
description: TNT Germany.
- type: string
enum:
- TNT_IT
description: TNT Italy.
- type: string
enum:
- TNT_JP
description: TNT Japan.
- type: string
enum:
- TNT_NL
description: TNT Netherlands.
- type: string
enum:
- TNT_PL
description: TNT Poland.
- type: string
enum:
- TNT_ES
description: TNT Spain.
- type: string
enum:
- TNT_UK
description: TNT UK.
- type: string
enum:
- TPG
description: TPG International & Domestic
Express.
- type: string
enum:
- TAIWAN_POST_TW
description: Taiwan Post.
- type: string
enum:
- TAQBIN_HK
description: TA-Q-BIN Parcel Hong Kong.
- type: string
enum:
- TAQBIN_MY
description: TA-Q-BIN Parcel Malaysia.
- type: string
enum:
- TAQBIN_SG
description: TA-Q-BIN Parcel Singapore.
- type: string
enum:
- TAXIPOST
description: TaxiPost.
- type: string
enum:
- TELIWAY
description: Teliway.
- type: string
enum:
- THAILAND_POST
description: Thailand Post.
- type: string
enum:
- THE_COURIER_GUY
description: The Courier Guy.
- type: string
enum:
- TIKI_ID
description: Tiki.
- type: string
enum:
- TOLL_IPEC
description: Toll IPEC.
- type: string
enum:
- TWO_GO
description: 2GO.
- type: string
enum:
- TRANSMISSION
description: Transmission Netherlands.
- type: string
enum:
- UK_MAIL
description: UK Mail.
- type: string
enum:
- UPS_MI
description: UPS Mail Innovations.
- type: string
enum:
- VIETNAM_POST
description: Vietnam Post.
- type: string
enum:
- WAHANA_ID
description: Wahana Express Indonesia.
- type: string
enum:
- XEND_EXPRESS_PH
description: Xend Express.
- type: string
enum:
- XPRESSBEES
description: Xpress Bees.
- type: string
enum:
- YAMATO
description: Yamato Japan.
- type: string
enum:
- YANWEN_CN
description: Yanwen China.
- type: string
enum:
- YODEL
description: Yodel.
- type: string
enum:
- UPS_CANADA
description: UPS Canada.
- type: string
enum:
- UPS_MAIL_INNOVATIONS
description: UPS Mail Innovations.
- type: string
enum:
- DE_DELTEC
description: Deltec Germany.
- type: string
enum:
- DE_INTERNATIONALSEUR
description: International Seur Germany.
- type: string
enum:
- FR_DPD
description: DPD France.
- type: string
enum:
- FR_IMX
description: IMX France.
- type: string
enum:
- IT_IMX
description: IMX Italy.
- type: string
enum:
- AU_DTDC
description: DTDC Australia.
- type: string
enum:
- AU_SENDLE
description: Sendle Australia.
- type: string
enum:
- AU_SKYNET
description: Skynet Australia.
- type: string
enum:
- ES_GLS
description: General Logistics Systems (GLS)
Spain.
- type: string
enum:
- ES_INTERNATIONALSEUR
description: Seur International Spain.
- type: string
enum:
- ES_IMX
description: IMX Spain.
- type: string
enum:
- CN_HUAHANEXPRESS
description: Huahan Express China.
- type: string
enum:
- LOCAL_PICKUP
description: Local Pickup.
- type: string
enum:
- HK_DPEX
description: DPEX Worldwide Hong Kong.
- type: string
enum:
- HK_KERRYEXPRESS
description: Kerry Express Hong Kong.
- type: string
enum:
- HK_LOGISTICSWORLDWIDEEXPRESS
description: Logistics Worldwide Express Hong Kong.
- type: string
enum:
- HK_RPX
description: RPX Hong Kong.
- type: string
enum:
- HK_SPREADEL
description: Spreadel Hong Kong.
- type: string
enum:
- IN_SPREADEL
description: Spreadel IN.
- type: string
enum:
- TH_CJ
description: CJ Thailand.
- type: string
enum:
- KR_LOGISTICSWORLDWIDE
description: Logistics Worldwide
Korea.
- type: string
enum:
- AT_DHL
description: DHL Austria.
- type: string
enum:
- BE_IMX
description: IMX Belgium.
- type: string
enum:
- MY_LOGISTICSWORLDWIDE
description: Logistics Worldwide
Malaysia.
- type: string
enum:
- MY_JETSHIP
description: Jetship Malaysia.
- type: string
enum:
- SG_DHL
description: DHL Singapore.
- type: string
enum:
- SG_SPREADEL
description: Spreadel Singapore.
- type: string
enum:
- POSTAROMANA
description: Romanian Post.
- type: string
enum:
- US_PUROLATOR
description: Purolator
US.
- type: string
enum:
- US_FASTWAY
description: Fastway US.
- type: string
enum:
- CHRONOPOST
description: Chronopost.
- type: string
enum:
- CORREOS_DE_ESPANA
description: Correos
de Espana.
- type: string
enum:
- DEUTSCHE_POST_DHL
description: Deutsche Post
DHL.
- type: string
enum:
- EBOOST_SDA
description: Posteitaliane.
- type: string
enum:
- HONGKONG_POST
description: Hong Kong Post.
- type: string
enum:
- INTANGIBLE_DIGITAL_SERVICES
description: Intangible Digital Services.
- type: string
enum:
- LA_POSTE
description: La Poste.
- type: string
enum:
- LA_POSTE_SUIVI
description: La Poste
Suivi.
- type: string
enum:
- NEKO_YAMATO_UNYUU
description: Yamato Transport
Co..
- type: string
enum:
- NITTSU_PELICAN_BIN
description: Nippon
Express.
- type: string
enum:
- POSTE_ITALIA
description: Posteitaliane.
- type: string
enum:
- SAGAWA_KYUU_BIN
description: Sagawa
Express Co..
- type: string
enum:
- STAR_TRACK_EXPRESS
description: Star
Track Express.
- type: string
enum:
- US_DTDC
description: DTDC US.
- type: string
enum:
- US_STARTRACK
description: Star Track US.
- type: string
enum:
- ISR_ISRAEL_POST
description: Israel Post.
- type: string
enum:
- BE_MONDIAL
description: Mondial Belgium.
- type: string
enum:
- B_2_CEUROPE
description: B2C Europe.
- type: string
enum:
- PHL_2_GO
description: 2GO Shipping Philippines.
- type: string
enum:
- PHL_AIR_21
description: Air 21 Philippines.
- type: string
enum:
- PT_SPANISH_SEUR
description: Internationational Seur Spanish
Portugal.
- type: string
enum:
- ES_SPANISH_SEUR
description: Seur Spain.
- type: string
enum:
- SG_DPEX
description: DPEX Worldwide Singapore.
- type: string
enum:
- CH_IMX
description: IMX Switzerland.
- type: string
enum:
- DHLG
description: DHLG.
- type: string
enum:
- RUSTON
description: Ruston
- type: string
enum:
- MIKROPAKKET
description: Mikropakket
- type: string
enum:
- XPOST
description: Xpost.ph
- type: string
enum:
- PAN_ASIA
description: Pan-Asia International
- type: string
enum:
- PARCELONE
description: PARCEL ONE
- type: string
enum:
- SPEEDEE
description: Spee-Dee Delivery
- type: string
enum:
- VENIPAK
description: Venipak
- type: string
enum:
- CROSHOT
description: Croshot
- type: string
enum:
- SHREENANDANCOURIER
description: SHREE NANDAN COURIER
- type: string
enum:
- EPST_GLBL
description: ePost Global
- type: string
enum:
- NEWGISTICS
description: Newgistics
- type: string
enum:
- POST_SLOVENIA
description: Post of Slovenia
- type: string
enum:
- JERSEY_POST
description: Jersey Post
- type: string
enum:
- WMG
description: WMG Delivery
- type: string
enum:
- BOMBINOEXP
description: Bombino Express Pvt
- type: string
enum:
- XQ_EXPRESS
description: XQ Express
- type: string
enum:
- FURDECO
description: Furdeco
- type: string
enum:
- LEGION_EXPRESS
description: Legion Express
- type: string
enum:
- YDH_EXPRESS
description: YDH express
- type: string
enum:
- LHT_EXPRESS
description: LHT Express
- type: string
enum:
- SOUTH_AFRICAN_POST_OFFICE
description: South African Post Office
- type: string
enum:
- GRUPO
description: Grupo ampm
- type: string
enum:
- SPOTON
description: SPOTON Logistics Pvt Ltd
- type: string
enum:
- DIMERCO
description: Dimerco Express Group
- type: string
enum:
- INTERPARCEL_UK
description: Interparcel UK
- type: string
enum:
- ABCUSTOM
description: AB Custom Group
- type: string
enum:
- IND_DELIVREE
description: deliverE
- type: string
enum:
- GLOBAL_ABF
description: ABF Freight
- type: string
enum:
- CN_BESTEXPRESS
description: Best Express
- type: string
enum:
- DX_SFTP
description: DX (SFTP)
- type: string
enum:
- PICKUPP_MYS
description: PICK UPP
- type: string
enum:
- XPERT_DELIVERY
description: Xpert Delivery
- type: string
enum:
- FMX
description: FMX
- type: string
enum:
- HELLMANN
description: Hellmann Worldwide Logistics
- type: string
enum:
- DHL_REFR
description: DHl (Reference number)
- type: string
enum:
- DHL_HK
description: DHL HonKong
- type: string
enum:
- SHIP_IT_ASIA
description: Ship It Asia
- type: string
enum:
- KERRY_ECOMMERCE
description: Kerry eCommerce
- type: string
enum:
- GOJEK
description: Gojek
- type: string
enum:
- FRETERAPIDO
description: Frete Rapido
- type: string
enum:
- YODEL_INTNL
description: Yodel International
- type: string
enum:
- CFL_LOGISTICS
description: CFL Logistics
- type: string
enum:
- PITNEY_BOWES
description: Pitney Bowes
- type: string
enum:
- ZA_SPECIALISED_FREIGHT
description: Specialised Freight
- type: string
enum:
- JANCO
description: Janco Ecommerce
- type: string
enum:
- XPRESSEN_DK
description: Xpressen courier
- type: string
enum:
- YTO
description: YTO Express
- type: string
enum:
- RPD2MAN
description: RPD2man Deliveries
- type: string
enum:
- SEUR_SP_API
description: Spanish Seur API
- type: string
enum:
- DELIVERYONTIME
description: DELIVERYONTIME LOGISTICS PVT LTD
- type: string
enum:
- WISE_EXPRESS
description: Wise Express
- type: string
enum:
- JINSUNG
description: JINSUNG TRADING
- type: string
enum:
- JTEXPRESS_VN
description: J&T Express Vietnam
- type: string
enum:
- CHUKOU1
description: Chukou1
- type: string
enum:
- TRANS_KARGO
description: Trans Kargo Internasional
- type: string
enum:
- FEDEX_INTL_MLSERV
description: FedEx International MailService
- type: string
enum:
- SWISHIP_DE
description: Swiship DE
- type: string
enum:
- IVOY_WEBHOOK
description: Ivoy courier
- type: string
enum:
- AIRMEE_WEBHOOK
description: Airmee couriers
- type: string
enum:
- VAMOX
description: VAMOX
- type: string
enum:
- FIRSTMILE
description: FirstMile
- type: string
enum:
- AMS_GRP
description: AMS Group
- type: string
enum:
- FASTWAY_IR
description: Fastway Ireland
- type: string
enum:
- HH_EXP
description: Hua Han Logistics
- type: string
enum:
- HRPARCEL
description: HR Parcel
- type: string
enum:
- MYS_MYPOST_ONLINE
description: Mypostonline
- type: string
enum:
- GESWL
description: GESWL Express
- type: string
enum:
- BLUESTAR
description: Blue Star
- type: string
enum:
- TIPSA
description: TIPSA courier
- type: string
enum:
- CDEK_TR
description: CDEK TR
- type: string
enum:
- KGMHUB
description: KGM Hub
- type: string
enum:
- INTEXPRESS
description: Internet Express
- type: string
enum:
- DESCARTES
description: Innovel courier
- type: string
enum:
- OVERSE_EXP
description: Overseas Express
- type: string
enum:
- ONECLICK
description: One click delivery services
- type: string
enum:
- ROADRUNNER_FREIGHT
description: Roadbull Logistics
- type: string
enum:
- GLS_CROTIA
description: GLS Croatia
- type: string
enum:
- TOURLINE
description: tourline
- type: string
enum:
- MRW_FTP
description: MRW courier
- type: string
enum:
- BH_WORLDWIDE
description: B&H Worldwide
- type: string
enum:
- BLUEX
description: Blue Express
- type: string
enum:
- DYLT
description: Daylight Transport
- type: string
enum:
- OCS
description: OCS ANA Group
- type: string
enum:
- YINGNUO_LOGISTICS
description: yingnuo logistics
- type: string
enum:
- SIN_GLBL
description: Sin Global Express
- type: string
enum:
- TUFFNELLS_REFERENCE
description: Tuffnells Parcels Express- Reference
- type: string
enum:
- CJPACKET
description: CJ Packet
- type: string
enum:
- MILKMAN
description: Milkman courier
- type: string
enum:
- FIEGE_NL
description: Fiege Netherlands
- type: string
enum:
- ASIGNA
description: ASIGNA courier
- type: string
enum:
- ONEWORLDEXPRESS
description: One World Express
- type: string
enum:
- LTIANEXP
description: LTIAN EXP
- type: string
enum:
- KWE_GLOBAL
description: KWE Global
- type: string
enum:
- CTC_EXPRESS
description: CTC Express
- type: string
enum:
- LAO_POST
description: Lao Post
- type: string
enum:
- EU_IMX
description: IMX Mail
- type: string
enum:
- GLS_SLOV
description: GLS General Logistics Systems Slovakia s.r.o.
- type: string
enum:
- AMAZON
description: Amazon Shipping
- type: string
enum:
- MORE_LINK
description: Morelink
- type: string
enum:
- JX
description: JX courier
- type: string
enum:
- MYS_EMS
description: Malaysia Post EMS / Pos Laju
- type: string
enum:
- EASY_MAIL
description: Easy Mail
- type: string
enum:
- ADUIEPYLE
description: A Duie Pyle
- type: string
enum:
- GB_PANTHER
description: Panther
- type: string
enum:
- SG_DETRACK
description: Detrack
- type: string
enum:
- EXPRESSSALE
description: Expresssale
- type: string
enum:
- DICOM
description: GLS Logistic Systems Canada Ltd./Dicom
- type: string
enum:
- MATDESPATCH
description: Matdespatch
- type: string
enum:
- TRUNKRS_WEBHOOK
description: Trunkrs courier
- type: string
enum:
- WESTBANK_COURIER
description: West Bank Courier
- type: string
enum:
- MBW
description: MBW Courier Inc.
- type: string
enum:
- KHM_CAMBODIA_POST
description: Cambodia Post
- type: string
enum:
- FEDEX_CROSSBORDER
description: FedEx Cross Border
- type: string
enum:
- JANIO
description: Janio Asia
- type: string
enum:
- SINOTRANS
description: Sinotrans
- type: string
enum:
- BRT_IT_PARCELID
description: BRT Bartolini(Parcel ID)
- type: string
enum:
- A1POST
description: A1Post
- type: string
enum:
- DHL_SUPPLY_CHAIN
description: DHL Supply Chain APAC
- type: string
enum:
- TAZMANIAN_FREIGHT
description: Tazmanian Freight Systems
- type: string
enum:
- TOPYOU
description: TopYou
- type: string
enum:
- PALEXPRESS
description: PAL Express Limited
- type: string
enum:
- SAIA_FREIGHT
description: Saia LTL Freight
- type: string
enum:
- CN_WEDO
description: WeDo Logistics
- type: string
enum:
- FULFILLME
description: Fulfillme
- type: string
enum:
- SG_QXPRESS
description: Qxpress
- type: string
enum:
- UPS_REFERENCE
description: UPS Reference
- type: string
enum:
- NHANS_SOLUTIONS
description: Nhans Solutions
- type: string
enum:
- CARIBOU
description: Caribou
- type: string
enum:
- LOCUS_WEBHOOK
description: Locus courier
- type: string
enum:
- DSV
description: DSV courier
- type: string
enum:
- CN_GOFLY
description: GoFly
- type: string
enum:
- COORDINADORA
description: Coordinadora
- type: string
enum:
- P2P_TRC
description: P2P TrakPak
- type: string
enum:
- ANDREANI
description: Grupo logistico Andreani
- type: string
enum:
- DIRECTPARCELS
description: Direct Parcels
- type: string
enum:
- DOORA
description: Doora Logistics
- type: string
enum:
- FEDEX_POLAND
description: FedEx® Poland Domestic
- type: string
enum:
- INTERPARCEL_NZ
description: Interparcel New Zealand
- type: string
enum:
- XDP_UK_REFERENCE
description: XDP Express Reference
- type: string
enum:
- ETOMARS
description: Etomars
- type: string
enum:
- CN_JCEX
description: JCEX courier
- type: string
enum:
- IND_ECOM
description: Ecom Express
- type: string
enum:
- FAR_INTERNATIONAL
description: FAR international
- type: string
enum:
- ESP_ENVIALIA
description: Envialia
- type: string
enum:
- IDEXPRESS
description: IDEX courier
- type: string
enum:
- GANGBAO
description: GANGBAO Supplychain
- type: string
enum:
- SMSA_EXPRESS
description: SMSA Express
- type: string
enum:
- NEWAY
description: Neway Transport
- type: string
enum:
- DEX_I
description: DEX-I courier
- type: string
enum:
- DESIGNERTRANSPORT_WEBHOOK
description: Designer Transport
- type: string
enum:
- BUDBEE_WEBHOOK
description: Budbee courier
- type: string
enum:
- GLS_SLOVEN
description: GLS Slovenia
- type: string
enum:
- PARCELLED_IN
description: Parcelled.in
- type: string
enum:
- COPA_COURIER
description: Copa Airlines Courier
- type: string
enum:
- GSI_EXPRESS
description: GSI EXPRESS
- type: string
enum:
- CON_WAY
description: Con-way Freight
- type: string
enum:
- BROUWER_TRANSPORT
description: Brouwer Transport en Logistiek
- type: string
enum:
- TOLL_NZ
description: Toll New Zealand
- type: string
enum:
- CPEX
description: Captain Express International
- type: string
enum:
- ECHO
description: Echo courier
- type: string
enum:
- FEDEX_FR
description: FedEx® Freight
- type: string
enum:
- XDE_WEBHOOK
description: Ximex Delivery Express
- type: string
enum:
- TOLOS
description: Tolos courier
- type: string
enum:
- BORDEREXPRESS
description: Border Express
- type: string
enum:
- GIAO_HANG
description: Giao hàng nhanh
- type: string
enum:
- MAILPLUS_JPN
description: MailPlus (Japan)
- type: string
enum:
- GEODIS_ESPACE
description: Geodis E-space
- type: string
enum:
- TNT_UK_REFR
description: TNT UK Reference
- type: string
enum:
- DOORDASH_WEBHOOK
description: DoorDash
- type: string
enum:
- KEC
description: KEC courier
- type: string
enum:
- CJ_HK_INTERNATIONAL
description: CJ Logistics International(Hong Kong)
- type: string
enum:
- HELTHJEM
description: Helthjem
- type: string
enum:
- ZA_COURIERIT
description: Courier IT
- type: string
enum:
- SFB2C
description: SF International
- type: string
enum:
- FREIGHTQUOTE
description: Freightquote by C.H. Robinson
- type: string
enum:
- FR_EXAPAQ
description: DPD France (formerly exapaq)
- type: string
enum:
- LANDMARK_GLOBAL_REFERENCE
description: Landmark Global Reference
- type: string
enum:
- PARCEL2GO
description: Parcel2Go
- type: string
enum:
- DELNEXT
description: Delnext
- type: string
enum:
- TCK_EXPRESS
description: TCK Express
- type: string
enum:
- ENDEAVOUR_DELIVERY
description: Endeavour Delivery
- type: string
enum:
- NANJINGWOYUAN
description: Nanjing Woyuan
- type: string
enum:
- HEPPNER_FR
description: Heppner France
- type: string
enum:
- PICKRR
description: Pickrr
- type: string
enum:
- FONSEN
description: Fonsen Logistics
- type: string
enum:
- APC_OVERNIGHT_CONNUM
description: APC Overnight Consignment
- type: string
enum:
- STAR_TRACK_NEXT_FLIGHT
description: Star Track Next Flight
- type: string
enum:
- UPS_FREIGHT
description: UPS Freight
- type: string
enum:
- DAJIN
description: Shanghai Aqrum Chemical Logistics Co.Ltd
- type: string
enum:
- POSTA_PLUS
description: Posta Plus
- type: string
enum:
- CEVA
description: CEVA LOGISTICS
- type: string
enum:
- ORANGE_DS
description: OrangeDS (Orange Distribution Solutions Inc)
- type: string
enum:
- ANSERX
description: ANSERX courier
- type: string
enum:
- JS_EXPRESS
description: JS EXPRESS
- type: string
enum:
- PADTF
description: padtf.com
- type: string
enum:
- GAC
description: GAC
- type: string
enum:
- EZSHIP
description: EZship
- type: string
enum:
- GEIS
description: Geis CZ
- type: string
enum:
- SYPOST
description: Sunyou Post
- type: string
enum:
- AMAZON_SHIP_MCF
description: Amazon Shipping + Amazon MCF
- type: string
enum:
- SF_EX
description: SF Express
- type: string
enum:
- YUSEN
description: Yusen Logistics
- type: string
enum:
- ESP_MRW
description: MRW spain
- type: string
enum:
- BRING
description: Bring
- type: string
enum:
- PAGO
description: Pago Logistics
- type: string
enum:
- AO_COURIER
description: AO Logistics
- type: string
enum:
- GBA
description: GBA Services Ltd
- type: string
enum:
- DIAMOND_EUROGISTICS
description: Diamond Eurogistics Limited
- type: string
enum:
- NEWEGGEXPRESS
description: Newegg Express
- type: string
enum:
- LALAMOVE
description: Lalamove
- type: string
enum:
- SPEEDCOURIERS_GR
description: Speed Couriers
- type: string
enum:
- CORPORATECOURIERS_WEBHOOK
description: Corporate Couriers
- type: string
enum:
- FORRUN
description: forrun Pvt Ltd (Arpatech Venture)
- type: string
enum:
- PICKUP
description: Pickupp
- type: string
enum:
- BOND
description: Bond courier
- type: string
enum:
- ECMS
description: ECMS International Logistics Co.
- type: string
enum:
- INTELIPOST
description: Intelipost (TMS for LATAM)
- type: string
enum:
- SK_POSTA
description: Slovenska pošta
- type: string
enum:
- FLASHEXPRESS
description: Flash Express
- type: string
enum:
- FETCHR_WEBHOOK
description: Mena 360 (Fetchr)
- type: string
enum:
- CN_STO
description: STO Express
- type: string
enum:
- SEKO_SFTP
description: SEKO Worldwide
- type: string
enum:
- THEDELIVERYGROUP
description: TDG – The Delivery Group
- type: string
enum:
- CELLO_SQUARE
description: Cello Square
- type: string
enum:
- HOME_DELIVERY_SOLUTIONS
description: Home Delivery Solutions Ltd
- type: string
enum:
- DPD_HGRY
description: DPD Hungary
- type: string
enum:
- KERRYTTC_VN
description: Kerry Express (Vietnam) Co Ltd
- type: string
enum:
- TARRIVE
description: TONDA GLOBAL
- type: string
enum:
- JOYING_BOX
description: Joying Box
- type: string
enum:
- COLLIVERY
description: MDS Collivery Pty (Ltd)
- type: string
enum:
- TOTAL_EXPRESS
description: Total Express
- type: string
enum:
- ZJS_EXPRESS
description: ZJS International
- type: string
enum:
- STARKEN
description: STARKEN couriers
- type: string
enum:
- MAINFREIGHT
description: Mainfreight
- type: string
enum:
- IND_FIRSTFLIGHT
description: First Flight Couriers
- type: string
enum:
- BE_BPOST
description: Bpost (www.bpost.be)
- type: string
enum:
- DEMANDSHIP
description: DemandShip
- type: string
enum:
- CN_DPEX
description: DPEX
- type: string
enum:
- ACSWORLDWIDE
description: ACS Worldwide Express
- type: string
enum:
- LOGISTERS
description: Logisters
- type: string
enum:
- GOGLOBALPOST
description: Global Post
- type: string
enum:
- AMSTAN
description: Amstan Logistics
- type: string
enum:
- OKAYPARCEL
description: OkayParcel
- type: string
enum:
- I_DIKA
description: i-dika
- type: string
enum:
- ENVIALIA_REFERENCE
description: Envialia Reference
- type: string
enum:
- PAACK_WEBHOOK
description: Paack courier
- type: string
enum:
- GRAB_WEBHOOK
description: Grab courier
- type: string
enum:
- PARCELPOINT
description: Parcelpoint
- type: string
enum:
- ICUMULUS
description: iCumulus
- type: string
enum:
- FDSEXPRESS
description: FDSEXPRESS
- type: string
enum:
- DAIGLOBALTRACK
description: DAI Post
- type: string
enum:
- CNDEXPRESS
description: CND Express
- type: string
enum:
- GLOBAL_IPARCEL
description: i-parcel
- type: string
enum:
- AMAZON_FBA_SWISHIP
description: Swiship UK
- type: string
enum:
- WYNGS
description: Wyngs
- type: string
enum:
- YURTICI_KARGO
description: Yurtici Kargo
- type: string
enum:
- CN_PAYPAL_PACKAGE
description: PayPal Package
- type: string
enum:
- PARCEL_2_POST
description: Parcel To Post
- type: string
enum:
- ZYLLEM
description: Zyllem
- type: string
enum:
- VIA_EXPRESS
description: Viaxpress
- type: string
enum:
- WIZMO
description: Wizmo
- type: string
enum:
- TIGFREIGHT
description: TIG Freight
- type: string
enum:
- PIL_LOGISTICS
description: PIL Logistics (China) Co.
- type: string
enum:
- ZTO_EXPRESS
description: ZTO Express
- type: string
enum:
- HEPPNER
description: Heppner Internationale Spedition GmbH & Co.
- type: string
enum:
- GENERAL_OVERNIGHT
description: Go!Express and logistics
- type: string
enum:
- HAPPY2POINT
description: Happy 2ThePoint
- type: string
enum:
- ARCO_SPEDIZIONI
description: Arco Spedizioni SP
- type: string
enum:
- CHITCHATS
description: Chit Chats
- type: string
enum:
- IML
description: IML courier
- type: string
enum:
- SMOOTH
description: Smooth Couriers
- type: string
enum:
- INTEL_VALLEY
description: Intel-Valley Supply chain (ShenZhen) Co. Ltd
- type: string
enum:
- CLE_LOGISTICS
description: CL E-Logistics Solutions Limited
- type: string
enum:
- FIEGE
description: Fiege Logistics
- type: string
enum:
- MX_CARGO
description: M&X cargo
- type: string
enum:
- ZIINGFINALMILE
description: Ziing Final Mile Inc
- type: string
enum:
- TCS
description: TCS courier
- type: string
enum:
- DAYTON_FREIGHT
description: Dayton Freight
- type: string
enum:
- ROADBULL
description: Red Carpet Logistics
- type: string
enum:
- YODEL_DIR
description: Yodel Direct
- type: string
enum:
- STONE3PL
description: STONE3PL
- type: string
enum:
- PARCELPAL_WEBHOOK
description: ParcelPal
- type: string
enum:
- DHL_ECOMERCE_ASA
description: DHL eCommerce Asia (API)
- type: string
enum:
- SIMPLYPOST
description: J&T Express Singapore
- type: string
enum:
- KY_EXPRESS
description: Kua Yue Express
- type: string
enum:
- SHENZHEN
description: shenzhen 1st International Logistics(Group)Co
- type: string
enum:
- UC_EXPRE
description: ucexpress
- type: string
enum:
- US_LASERSHIP
description: LaserShip
- type: string
enum:
- DIDADI
description: DIDADI Logistics tech
- type: string
enum:
- DYNALOGIC
description: Dynamic Logistics
- type: string
enum:
- DBSCHENKER_B2B
description: DB Schenker B2B
- type: string
enum:
- MXE
description: MXE Express
- type: string
enum:
- PFCEXPRESS
description: PFC Express
- type: string
enum:
- WHISTL
description: Whistl
- type: string
enum:
- CAE_DELIVERS
description: CAE Delivers
- type: string
enum:
- WEPOST
description: WePost Sdn Bhd
- type: string
enum:
- ALLIEDEXPRESS
description: Allied Express
- type: string
enum:
- SHIPPIT
description: Shippit
- type: string
enum:
- DDEXPRESS
description: DD Express Courier
- type: string
enum:
- ARAMEX_AU
description: Aramex Australia (formerly Fastway AU)
- type: string
enum:
- TFM
description: TFM Xpress
- type: string
enum:
- BNEED
description: Bneed courier
- type: string
enum:
- M_XPRESS
description: M Xpress Sdn Bhd
- type: string
enum:
- HK_TGX
description: Kerry Express Hong Kong
- type: string
enum:
- LATVIJAS_PASTS
description: Latvijas Pasts
- type: string
enum:
- HDB_BOX
description: Haidaibao (BOX)
- type: string
enum:
- VIAEUROPE
description: ViaEurope
- type: string
enum:
- CORREO_UY
description: Correo Uruguayo
- type: string
enum:
- CLEVY_LINKS
description: Clevy Links
- type: string
enum:
- IBEONE
description: Beone Logistics
- type: string
enum:
- J_NET
description: J-Net
- type: string
enum:
- RCL
description: Red Carpet Logistics
- type: string
enum:
- 6LS
description: 6ls.com
- type: string
enum:
- CGS_EXPRESS
description: CGS Express
- type: string
enum:
- BLR_BELPOST
description: Belpost
- type: string
enum:
- BIRDSYSTEM
description: BirdSystem
- type: string
enum:
- DOBROPOST
description: DobroPost
- type: string
enum:
- SAP_EXPRESS
description: SAP EXPRESS
- type: string
enum:
- WEASHIP
description: Weaship
- type: string
enum:
- SONICTL
description: Sonic Transportation & Logistics
- type: string
enum:
- KWT
description: Shenzhen Jinghuada Logistics Co.
- type: string
enum:
- AFLLOG_FTP
description: AFL LOGISTICS
- type: string
enum:
- IND_SAFEEXPRESS
description: Safexpress
- type: string
enum:
- TOPHATTEREXPRESS
description: Tophatter Express
- type: string
enum:
- SEINO
description: Seino
- type: string
enum:
- MGLOBAL
description: PT MGLOBAL LOGISTICS INDONESIA
- type: string
enum:
- SZENDEX
description: SZENDEX
- type: string
enum:
- AVERITT
description: Averitt Express
- type: string
enum:
- DBSCHENKER_SV
description: DB Schenker Sweden
- type: string
enum:
- LEADER
description: leader
- type: string
enum:
- AO_DEUTSCHLAND
description: AO Deutschland
- type: string
enum:
- 2EBOX
description: 2ebox courier
- type: string
enum:
- EU_FLEET_SOLUTIONS
description: EU Fleet Solutions
- type: string
enum:
- SG_SPEEDPOST
description: Singapore Speedpost
- type: string
enum:
- PCFCORP
description: PCF Final Mile
- type: string
enum:
- AERONET
description: Aeronet couriers
- type: string
enum:
- LINKBRIDGE
description: Link Bridge(BeiJing)international logistics co.
- type: string
enum:
- DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET
description: Deutsche Post DHL
- type: string
enum:
- PRIMAMULTICIPTA
description: PT Prima Multi Cipta
- type: string
enum:
- ISR_POST_DOMESTIC
description: Israel Post Domestic
- type: string
enum:
- COUREX
description: Urbanfox
- type: string
enum:
- ZAJIL_EXPRESS
description: Zajil Express Company
- type: string
enum:
- BESTWAYPARCEL
description: Best Way Parcel
- type: string
enum:
- COLLECTCO
description: CollectCo
- type: string
enum:
- AEX
description: AEX Group
- type: string
enum:
- JTEXPRESS
description: J&T EXPRESS MALAYSIA
- type: string
enum:
- FEDEX_UK
description: FedEx® UK
- type: string
enum:
- USHIP
description: uShip courier
- type: string
enum:
- ROUTIFIC_WEBHOOK
description: Routific
- type: string
enum:
- GLOBAL_EXPRESS
description: Tai Wan Global Business
- type: string
enum:
- BRT_IT_SENDER_REF
description: BRT Bartolini(Sender Reference)
- type: string
enum:
- GLOBAVEND
description: Globavend
- type: string
enum:
- PIXSELL
description: PIXSELL LOGISTICS
- type: string
enum:
- SHIPTOR
description: Shiptor
- type: string
enum:
- CDEK
description: CDEK courier
- type: string
enum:
- VNM_VIETTELPOST
description: ViettelPost
- type: string
enum:
- PHL_AIR21
description: AIR21 courier
- type: string
enum:
- PALLET_NETWORK
description: The Pallet Network
- type: string
enum:
- CJ_CENTURY
description: CJ Century
- type: string
enum:
- UK_XDP
description: XDP Express
- type: string
enum:
- GSO
description: GSO(GLS-USA)
- type: string
enum:
- VIWO
description: VIWO IoT
- type: string
enum:
- SKYBOX
description: SKYBOX
- type: string
enum:
- PAPER_EXPRESS
description: Paper Express
- type: string
enum:
- KERRYTJ
description: Kerry TJ Logistics
- type: string
enum:
- NTLOGISTICS_VN
description: Nhat Tin Logistics
- type: string
enum:
- SDH_SCM
description: lightning monkey
- type: string
enum:
- PALLETWAYS
description: Palletways
- type: string
enum:
- NOX_NACHTEXPRESS
description: Innight Express Germany GmbH (nox NachtExpress)
- type: string
enum:
- ZINC
description: Zinc courier
- type: string
enum:
- DPE_SOUTH_AFRC
description: DPE South Africa
- type: string
enum:
- LOGISTIKA
description: Logistika
- type: string
enum:
- CELERITAS
description: Celeritas Transporte
- type: string
enum:
- PRESSIODE
description: Pressio
- type: string
enum:
- SHREE_MARUTI
description: Shree Maruti Courier Services Pvt Ltd
- type: string
enum:
- PARCELINKLOGISTICS
description: Parcelink Logistics
- type: string
enum:
- EFEX
description: eFEx (E-Commerce Fulfillment & Express)
- type: string
enum:
- LOTTE
description: Lotte Global Logistics
- type: string
enum:
- LONESTAR
description: Lone Star Overnight
- type: string
enum:
- GB_NORSK
description: Norsk Global
- type: string
enum:
- APRISAEXPRESS
description: Aprisa Express
- type: string
enum:
- BEL_RS
description: BEL North Russia
- type: string
enum:
- OSM_WORLDWIDE
description: OSM Worldwide
- type: string
enum:
- SAILPOST
description: SAILPOST
- type: string
enum:
- MAILAMERICAS
description: MailAmericas
- type: string
enum:
- WESTGATE_GL
description: Westgate Global
- type: string
enum:
- DTD_EXPR
description: DTD Express
- type: string
enum:
- ALFATREX
description: AlfaTrex
- type: string
enum:
- THABIT_LOGISTICS
description: Thabit Logistics
- type: string
enum:
- PROMEDDELIVERY
description: ProMed Delivery
- type: string
enum:
- PAQUETEXPRESS
description: Paquetexpress
- type: string
enum:
- NEWZEALAND_COURIERS
description: NEW ZEALAND COURIERS
- type: string
enum:
- LIEFERY
description: liefery
- type: string
enum:
- JOOM_LOGIS
description: Joom Logistics
- type: string
enum:
- STRECK_TRANSPORT
description: Streck Transport
- type: string
enum:
- HCT_LOGISTICS
description: HCT LOGISTICS CO.LTD.
- type: string
enum:
- ZA_FASTWAY
description: fastway New Zealand
- type: string
enum:
- CARRY_FLAP
description: Carry-Flap Co.
- type: string
enum:
- PONY_EXPRESS
description: Pony express
- type: string
enum:
- US_OLD_DOMINION
description: Old Dominion Freight Line
- type: string
enum:
- ANICAM_BOX
description: ANICAM BOX EXPRESS
- type: string
enum:
- ALWAYS_EXPRESS
description: Always Express
- type: string
enum:
- WANBEXPRESS
description: WanbExpress
- type: string
enum:
- AUS_STARTRACK
description: StarTrack (startrack.com.au)
- type: string
enum:
- GBS_BROKER
description: GBS-Broker
- type: string
enum:
- STALLIONEXPRESS
description: Stallion Express
- type: string
enum:
- RAIDEREX
description: RaidereX
- type: string
enum:
- ALLJOY
description: ALLJOY SUPPLY CHAIN
- type: string
enum:
- SHOPFANS
description: ShopfansRU LLC
- type: string
enum:
- KYUNGDONG_PARCEL
description: Kyungdong Parcel
- type: string
enum:
- CHAMPION_LOGISTICS
description: Champion Logistics
- type: string
enum:
- PICKUPP_SGP
description: PICK UPP (Singapore)
- type: string
enum:
- DEALERSEND
description: DealerSend
- type: string
enum:
- MORNING_EXPRESS
description: Morning Express
- type: string
enum:
- NACEX
description: NACEX
- type: string
enum:
- THENILE_WEBHOOK
description: SortHub courier
- type: string
enum:
- JOCOM
description: Jocom
- type: string
enum:
- HOLISOL
description: Holisol
- type: string
enum:
- LBCEXPRESS_FTP
description: LBC EXPRESS INC.
- type: string
enum:
- CSE
description: CSE courier
- type: string
enum:
- TFORCE_FINALMILE
description: TForce Final Mile
- type: string
enum:
- KURASI
description: KURASI
- type: string
enum:
- GEMWORLDWIDE
description: GEM Worldwide
- type: string
enum:
- SHIP_GATE
description: ShipGate
- type: string
enum:
- USF_REDDAWAY
description: USF Reddaway
- type: string
enum:
- SHIPTER
description: SHIPTER
- type: string
enum:
- NATIONAL_SAMEDAY
description: National Sameday
- type: string
enum:
- APG
description: "APG eCommerce Solutions "
- type: string
enum:
- CN_BOXC
description: BoxC courier
- type: string
enum:
- YUNEXPRESS
description: YunExpress
- type: string
enum:
- INTEGRA2_FTP
description: Integra2
- type: string
enum:
- CAINIAO
description: AliExpress Standard Shipping
- type: string
enum:
- ECOSCOOTING
description: ECOSCOOTING
- type: string
enum:
- DMS_MATRIX
description: DMSMatrix
- type: string
enum:
- MAINWAY
description: Mainway
- type: string
enum:
- ASENDIA_USA
description: Asendia USA
- type: string
enum:
- PAPERFLY
description: Paperfly Private Limited
- type: string
enum:
- HOUNDEXPRESS
description: Hound Express
- type: string
enum:
- 3JMSLOGISTICS
description: 3JMS Logistics
- type: string
enum:
- EP_BOX
description: EP-Box courier
- type: string
enum:
- BOX_BERRY
description: Boxberry courier
- type: string
enum:
- LICCARDI_EXPRESS
description: LICCARDI EXPRESS COURIER
- type: string
enum:
- PLUS_LOG_UK
description: Plus UK Logistics
- type: string
enum:
- FULFILLA
description: Fulfilla
- type: string
enum:
- SKY_POSTAL
description: SkyPostal
- type: string
enum:
- ASE
description: ASE KARGO
- type: string
enum:
- CNWANGTONG
description: cnwangtong
- type: string
enum:
- PITTOHIO
description: PITT OHIO
- type: string
enum:
- MAIL_PLUS
description: MailPlus
- type: string
enum:
- XPO_LOGISTICS
description: XPO logistics
- type: string
enum:
- WNDIRECT
description: wnDirect
- type: string
enum:
- CLOUDWISH_ASIA
description: Cloudwish Asia
- type: string
enum:
- ZELERIS
description: Zeleris
- type: string
enum:
- MARA_XPRESS
description: Mara Xpress
- type: string
enum:
- GIO_EXPRESS
description: Gio Express
- type: string
enum:
- OCS_WORLDWIDE
description: OCS WORLDWIDE
- type: string
enum:
- DESTINY
description: Destiny Transportation
- type: string
enum:
- ARK_LOGISTICS
description: ARK Logistics
- type: string
enum:
- DE_DPD_DELISTRACK
description: DPD Germany
- type: string
enum:
- COMET_TECH
description: CometTech
- type: string
enum:
- DHL_PARCEL_RU
description: DHL Parcel Russia
- type: string
enum:
- AQUILINE
description: Aquiline
- type: string
enum:
- PILOT_FREIGHT
description: Pilot Freight Services
- type: string
enum:
- TNT_REFR
description: TNT Reference
- type: string
enum:
- QWINTRY
description: Qwintry Logistics
- type: string
enum:
- DANSKE_FRAGT
description: Danske Fragtaend
- type: string
enum:
- SHREE_ANJANI_COURIER
description: Shree Anjani Courier
- type: string
enum:
- CARRIERS
description: Carriers courier
- type: string
enum:
- AIR_CANADA_GLOBAL
description: Rivo (Air canada)
- type: string
enum:
- PRESIDENT_TRANS
description: PRESIDENT TRANSNET CORP
- type: string
enum:
- STEPFORWARDFS
description: STEP FORWARD FREIGHT SERVICE CO LTD
- type: string
enum:
- ESHIPPING
description: Eshipping
- type: string
enum:
- SHREETIRUPATI
description: SHREE TIRUPATI COURIER SERVICES PVT. LTD.
- type: string
enum:
- HX_EXPRESS
description: HX Express
- type: string
enum:
- INDOPAKET
description: INDOPAKET
- type: string
enum:
- CN_17POST
description: 17 Post Service
- type: string
enum:
- K1_EXPRESS
description: K1 Express
- type: string
enum:
- CJ_GLS
description: CJ GLS
- type: string
enum:
- MYS_GDEX
description: GDEX courier
- type: string
enum:
- NATIONEX
description: Nationex courier
- type: string
enum:
- CN_EQUICK
description: Equick China
- type: string
enum:
- ANJUN
description: Anjun couriers
- type: string
enum:
- VIRTRANSPORT
description: VIR Transport
- type: string
enum:
- FARGOOD
description: FarGood
- type: string
enum:
- SMG_EXPRESS
description: SMG Direct
- type: string
enum:
- RZYEXPRESS
description: RZY Express
- type: string
enum:
- SEFL
description: Southeastern Freight Lines
- type: string
enum:
- HIPSHIPPER
description: Hipshipper
- type: string
enum:
- HDB
description: Haidaibao
- type: string
enum:
- RPXLOGISTICS
description: RPX Logistics
- type: string
enum:
- MIKROPAKKET_BE
description: Mikropakket Belgium
- type: string
enum:
- KUEHNE
description: Kuehne + Nagel
- type: string
enum:
- IT_NEXIVE
description: Nexive (TNT Post Italy)
- type: string
enum:
- PTS
description: PTS courier
- type: string
enum:
- ETS_EXPRESS
description: RETS express
- type: string
enum:
- SWISS_POST_FTP
description: Swiss Post FTP
- type: string
enum:
- COLIS_PRIVE
description: Colis Privé
- type: string
enum:
- FASTRK_SERV
description: Fastrak Services
- type: string
enum:
- 4_72
description: 4-72 Entregando
- type: string
enum:
- US_YRC
description: YRC courier
- type: string
enum:
- CN_YUNDA
description: Yunda Express
- type: string
enum:
- POSTNL_INTL_3S
description: PostNL International 3S
- type: string
enum:
- AAA_COOPER
description: AAA Cooper
- type: string
enum:
- ELIAN_POST
description: Yilian (Elian) Supply Chain
- type: string
enum:
- CUBYN
description: Cubyn
- type: string
enum:
- SAU_SAUDI_POST
description: Saudi Post
- type: string
enum:
- 360LION
description: 360 Lion Express
- type: string
enum:
- ABXEXPRESS_MY
description: ABX Express
- type: string
enum:
- NINJAVAN_WB
description: Ninjavan Webhook
- type: string
enum:
- ESP_PACKLINK
description: Packlink
- type: string
enum:
- IND_JAYONEXPRESS
description: Jayon Express (JEX)
- type: string
enum:
- GB_ARROW
description: Arrow XL
- type: string
enum:
- ZES_EXPRESS
description: Eshun international Logistic
- type: string
enum:
- IND_GOJAVAS
description: GoJavas
- type: string
enum:
- ZEPTO_EXPRESS
description: ZeptoExpress
- type: string
enum:
- SKYNET_ZA
description: Skynet World Wide Express South Africa
- type: string
enum:
- KPOST
description: Korea Post
- type: string
enum:
- ZEEK_2_DOOR
description: Zeek2Door
- type: string
enum:
- DHL_FREIGHT
description: DHL Freight
- type: string
enum:
- BLUECARE
description: Bluecare Express Ltd
- type: string
enum:
- BLINKLASTMILE
description: Blink
- type: string
enum:
- POSTA_UKR
description: UkrPoshta
- type: string
enum:
- LOGISTYX_TRANSGROUP
description: Transgroup courier
- type: string
enum:
- JINDOUYUN
description: jindouyun courier
- type: string
enum:
- CHROBINSON
description: C.H. Robinson Worldwide
- type: string
enum:
- TRACKON
description: Trackon Couriers Pvt. Ltd
- type: string
enum:
- CN_POST56
description: Post56
- type: string
enum:
- GB_TUFFNELLS
description: Tuffnells Parcels Express
- type: string
enum:
- COURANT_PLUS
description: Courant Plus
- type: string
enum:
- SCUDEX_EXPRESS
description: Scudex Express
- type: string
enum:
- SHIPENTEGRA
description: ShipEntegra
- type: string
enum:
- TRUMPCARD
description: TRUMPCARD LLC
- type: string
enum:
- CHOIR_EXP
description: Choir Express Indonesia
- type: string
enum:
- ETOTAL
description: eTotal Solution Limited
- type: string
enum:
- COPE
description: Cope Sensitive Freight
- type: string
enum:
- SFPLUS_WEBHOOK
description: Zeek courier
- type: string
enum:
- IND_GATI
description: Gati-KWE
- type: string
enum:
- HERMES_2MANN_HANDLING
description: Hermes Einrichtungs Service GmbH & Co. KG
- type: string
enum:
- CN_WISHPOST
description: WishPost
- type: string
enum:
- GLOBALTRANZ
description: GlobalTranz
- type: string
enum:
- HKD
description: Qingdao HKD International Logistics
- type: string
enum:
- UDS
description: United Delivery Service
- type: string
enum:
- BJSHOMEDELIVERY
description: BJS Distribution courier
- type: string
enum:
- YAKIT
description: Yakit courier
- type: string
enum:
- LEXSHIP
description: LexShip
- type: string
enum:
- OMNIVA
description: Omniva
- type: string
enum:
- SUTTON
description: Sutton Transport
- type: string
enum:
- COSTMETICSNOW
description: Cosmetics Now
- type: string
enum:
- PANTHER_REFERENCE
description: Panther Reference
- type: string
enum:
- SFCSERVICE
description: SFC Service
- type: string
enum:
- PFLOGISTICS
description: PFL
- type: string
enum:
- LTL
description: LTL COURIER
- type: string
enum:
- LOOMIS_EXPRESS
description: Loomis Express
- type: string
enum:
- PARKNPARCEL
description: Park N Parcel
- type: string
enum:
- SPRING_GDS
description: Spring GDS
- type: string
enum:
- GLS_ITALY
description: GLS Italy
- type: string
enum:
- ECEXPRESS
description: ECexpress
- type: string
enum:
- LINE
description: Line Clear Express & Logistics Sdn Bhd
- type: string
enum:
- INTERPARCEL_AU
description: Interparcel Australia
- type: string
enum:
- GEL_EXPRESS
description: Gel Express Logistik
- type: string
enum:
- AGILITY
description: Agility
- type: string
enum:
- XL_EXPRESS
description: XL Express
- type: string
enum:
- ADERONLINE
description: Ader couriers
- type: string
enum:
- DIRECTCOURIERS
description: Direct Couriers
- type: string
enum:
- PLANZER
description: Planzer Group
- type: string
enum:
- NOX_NIGHT_TIME_EXPRESS
description: NOX NightTimeExpress
- type: string
enum:
- SENDING
description: Sending Transporte Urgente y Comunicacion
- type: string
enum:
- HUODULL
description: Huodull
carrier_name_other:
type: string
minLength: 1
maxLength: 2000
pattern: ^.*$
description: The name of carrier in free-form text for unavailable carriers.
This field is mandatory when carrier_name is
OTHER.
tracking_url:
type: string
format: uri
description: The URL to track the dispute-related transaction shipment.
tracking_number:
type: string
minLength: 1
maxLength: 255
pattern: ^.*$
description: The number to track the dispute-related transaction shipment.
required:
- carrier_name
- tracking_number
tracking_info_list:
type: array
minItems: 1
maxItems: 10
description: An array of relevant tracking information for the transaction
involved in this dispute.
items:
$ref: "#/components/schemas/tracking_info"
transaction_info:
type: object
title: Transaction Information
description: The information about the disputed transaction.
properties:
buyer_transaction_id:
type: string
minLength: 1
maxLength: 255
description: The ID, as seen by the customer, for this transaction.
pattern: ^[A-Za-z0-9-]+$
seller_transaction_id:
type: string
minLength: 1
maxLength: 255
description: The ID, as seen by the merchant, for this transaction.
pattern: ^[A-Za-z0-9-]+$
reference_id:
type: string
minLength: 1
maxLength: 255
description: The ID, as seen by the partner, for this transaction.
pattern: ^.*$
create_time:
description: The date and time when the transaction was created, in [Internet
date and time
format](https://tools.ietf.org/html/rfc3339#section-5.6). For
example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.
$ref: "#/components/schemas/date_time"
transaction_status:
type: string
minLength: 1
maxLength: 255
pattern: ^[0-9A-Z_]+$
description: The transaction status.
enum:
- COMPLETED
- UNCLAIMED
- DENIED
- FAILED
- HELD
- PENDING
- PARTIALLY_REFUNDED
- REFUNDED
- REVERSED
- CANCELLED
oneOf:
- type: string
enum:
- COMPLETED
description: The transaction processing completed.
- type: string
enum:
- UNCLAIMED
description: The items in the transaction are unclaimed. If they are not claimed
within 30 days, the funds are returned to the sender.
- type: string
enum:
- DENIED
description: The transaction was denied.
- type: string
enum:
- FAILED
description: The transaction failed.
- type: string
enum:
- HELD
description: The transaction is on hold.
- type: string
enum:
- PENDING
description: The transaction is waiting to be processed.
- type: string
enum:
- PARTIALLY_REFUNDED
description: The payment for the transaction was partially refunded.
- type: string
enum:
- REFUNDED
description: The payment for the transaction was successfully refunded.
- type: string
enum:
- REVERSED
description: The payment for the transaction was reversed due to a chargeback or
other reversal type.
- type: string
enum:
- CANCELLED
description: The transaction is cancelled.
gross_amount:
description: The gross amount of the transaction.
$ref: "#/components/schemas/money"
gross_asset:
description: The gross asset of the transaction.
$ref: "#/components/schemas/cryptocurrency"
invoice_number:
type: string
minLength: 1
maxLength: 127
description: The ID of the invoice for the payment.
pattern: ^[A-Za-z0-9:\-|]+$
custom:
type: string
minLength: 1
maxLength: 2000
pattern: ^(.|\r?\n)*$
description: A free-text field that is entered by the merchant during checkout.
buyer:
$ref: "#/components/schemas/buyer"
seller:
$ref: "#/components/schemas/seller"
items:
$ref: "#/components/schemas/item_info_list"
payment_processor:
$ref: "#/components/schemas/payment_processor"
transaction_info_list:
type: array
minItems: 1
maxItems: 1000
description: An array of transactions for which disputes were created.
items:
$ref: "#/components/schemas/transaction_info"
parameters:
start_time:
name: start_time
in: query
description: DEPRECATED. Please check the alternate field create_time_after.
Filters the disputes in the response by a creation date and time. The
start time must be within the last 180 days. Value is in [Internet date
and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For
example,
*`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.REQUIRED_ACTION dispute state.
- enum:
- REQUIRED_OTHER_PARTY_ACTION
description: Filters the disputes in the response to those with the
REQUIRED_OTHER_PARTY_ACTION dispute state.
- enum:
- UNDER_PAYPAL_REVIEW
description: Filters the disputes in the response to those with the
UNDER_PAYPAL_REVIEW dispute state.
- enum:
- RESOLVED
description: Filters the disputes in the response to those with the
RESOLVED dispute state.
- enum:
- OPEN_INQUIRIES
description: Filters the disputes in the response to those with the
OPEN_INQUIRIES dispute state.
- enum:
- APPEALABLE
description: Filters the disputes in the response to those with the
APPEALABLE dispute state.
create_time_before:
name: create_time_before
in: query
description: The date and time when the dispute was created, in [Internet date
and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For
example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.
schema:
type: string
minLength: 20
maxLength: 64
pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$
create_time_after:
name: create_time_after
in: query
description: The date and time when the dispute was created, in [Internet date
and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For
example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.
schema:
type: string
minLength: 20
maxLength: 64
pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$
update_time_before:
name: update_time_before
in: query
description: The date and time when the dispute was last updated, in [Internet
date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.
update_time_before must be within the last 180 days and the default is
the current time.
schema:
type: string
minLength: 20
maxLength: 64
pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$
update_time_after:
name: update_time_after
in: query
description: The date and time when the dispute was last updated, in [Internet
date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.
update_time_after must be within the last 180 days and the default is
the maximum time (180 days) supported.
schema:
type: string
minLength: 20
maxLength: 64
pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$
id:
name: id
in: path
description: The ID of the dispute for which to provide the supporting information.
required: true
schema:
type: string
minLength: 1
maxLength: 255
pattern: ^[A-Za-z0-9-]+$
content_type:
name: Content-Type
in: header
description: Content type of the request payload.
required: true
schema:
type: string
minLength: 1
maxLength: 255
pattern: \w+\/[-+.\w]+
x-errors:
- name: ACTION_NOT_ALLOWED_IN_CURRENT_DISPUTE_STATE
message: This action is not allowed for this dispute ID. For the allowed
actions, see the HATEOAS link in [show dispute
details](/docs/api/customer-disputes/v1/#disputes_get).
description: You cannot complete this action for this dispute ID.
- name: AMOUNT_SHOULD_NOT_BE_PASSED
message: For `MERCHANDISE_OR_SERVICE_NOT_RECEIVED` disputes, refund amount
cannot be specified in accept claim as this feature is not yet supported
in PayPal Dispute system.
description: You cannot specify the refund amount in an accept claim call.
- name: AUTHORIZATION_ERROR
message: Authorization error occurred.
description: An authorization error occurred. Check your credentials.
- name: DATE_CAN_NOT_BE_IN_FUTURE
message: The `start_time` is incorrect. The `start_time` must be earlier than
the current date and time stamp.
description: The specified start time is in the future.
- name: DISPUTE_REASON_NOT_ELIGIBLE
message: This dispute reason is not allowed for this transaction. To review the
allowed reasons for this transaction, call validate transaction
eligibility. Then, retry with one of the allowed reasons.
description: The specified dispute reason is not valid.
- name: INSUFFICIENT_FUNDS
message: You have insufficient funds in your account to accept a claim for this
dispute. Add the appropriate balance to your PayPal account before you
accept a claim for this case.
description: Your account has insufficient funds for this claim.
- name: INTANGIBLE_ITEM_CANNOT_BE_RETURNED
message: Return shipping address cannot be specified in accept claim for
intangible item related disputes as this applies only for tangible item
related transactions.
description: You cannot specify the shipping address in an accept claim call for
intangible item-related disputes.
- name: INTERNAL_SERVICE_ERROR
message: An internal service error has occurred.
description: Resend the request at another time.
- name: INVALID_EVIDENCE_FILE
message: The evidence file is not valid. The user can upload up to 50 MB of
files for a case. Individual files must be smaller than 10 MB. The
supported file formats are JPG, GIF, PNG, and PDF. Correct and retry the
request.
description: The evidence file is not valid.
- name: INVALID_EVIDENCE_TYPE_PROOF_OF_FULFILLMENT
message: The `PROOF_OF_FULFILLMENT` evidence type is not a valid evidence type
for this dispute reason and status. Retry the request with a different
evidence type.
description: This evidence type is not valid for this dispute reason and status.
- name: INVALID_PAGE_SIZE
message: The `page_size` is outside the allowed range. A valid `page_size` is
from 1 to 50. Retry the request.
description: The page size is outside the allowed range.
- name: INVALID_RETURN_SHIPPING_ADDRESS_FORMAT
message: The format specified for the return shipping address is not valid.
Correct the format and retry. See [accept
claim](/docs/api/customer-disputes/v1/#disputes-actions_accept-claim).
description: The shipping address format is not valid.
- name: INVALID_START_TIME_FORMAT
message: The `start_time` is not in the correct date and time format. The
`start_time` must be in [Internet date and time
format](https://tools.ietf.org/html/rfc3339#section-5.6). For example,
yyyy-MM-ddTHH:mm:ss.SSSZ.
Retry the request with the correct date and time format.
description: The start time is not in the correct date and time format.
- name: INVALID_START_TIME_RANGE
message: The `start_time` is outside the allowed range. The `start_time` must be
within the last 180 days. Retry the request with a valid `start_time`.
description: The start time is outside the allowed range.
- name: ITEM_ID_IS_MANDATORY_FOR_MULTIPLE_EVIDENCES
message: An item ID is required for this dispute. Provide an item ID for each
evidence document. For details, see [provide
evidence](/docs/api/customer-disputes/v1/#disputes-actions_provide-evidence).
description: An item ID is required.
- name: MANDATORY_PARAMETER_MISSING
message: When you create a dispute, a `buyer_transaction_id` is required but it
is missing. Retry with a valid `buyer_transaction_id`.
description: The customer transaction ID, or buyer_transaction_id,
is missing.
- name: MISSING_EVIDENCE_INFO
message: The evidence information is required but it is missing for this
dispute. Retry the request with valid evidence information. For details,
see [provide
evidence](/docs/api/customer-disputes/v1/#disputes-actions_provide-evidence).
description: The evidence information is missing.
- name: MISSING_EVIDENCE_TYPE
message: The evidence type is required but it is missing for this dispute. Retry
the request with a valid evidence type. For details, see [provide
evidence](/docs/api/customer-disputes/v1/#disputes-actions_provide-evidence).
description: The evidence type is missing.
- name: MISSING_REFUND_ID
message: For `PROOF_OF_REFUND`, at least one refund ID is required but it is
missing. Retry the request with a valid refund ID. For information, For
details, see [provide
evidence](/docs/api/customer-disputes/v1/#disputes-actions_provide-evidence).
description: A refund ID is missing. You specify PROOF_OF_REFUND in
the evidence_type parameter of a provide
evidence call.
- name: MISSING_REASON_CODE
message: To add or update a reason code, you must provide a reason code but it
is missing. Retry the request with a valid reason code.
description: A reason code is missing.
- name: MISSING_RETURN_SHIPPING_ADDRESS
message: For `MERCHANDISE_OR_SERVICE_NOT_RECEIVED` cases, return shipping
address cannot be specified in accept claim as this applies only for
`MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED` disputes.
description: You cannot specify the return shipping address in an accept claim
call because the shipping address applies to only
`MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED` disputes.
- name: MISSING_TRACKING_INFO
message: For `PROOF_OF_FULFILLMENT`, the tracking number and carrier name are
required but they are missing. Retry the request. For information, see
[`response_tracking_info`](/docs/api/customer-disputes/v1/#definition-response_tracking_info).
description: The tracking number and carrier name are missing. You specify
PROOF_OF_FULFILLMENT in the evidence_type
parameter of a provide
evidence call.
- name: PERMISSION_DENIED
message: You do not have the correct permission for the requested operation.
description: You do not have the correct permissions to make this request.
- name: REFUND_DECLINED_BY_COMPLIANCE_SCANNING
message: The refund has been declined by compliance scanning.
description: Refund declined by Compliance Scanning.
- name: RESOURCE_NOT_FOUND_ERROR
message: Resource not found.
description: The requested resource is not found in the system.
- name: SHIPPING_ADDRESS_SHOULD_NOT_BE_PASSED
message: If seller proposed offer is less than buyer requested refund amount,
shipping address must be specified for
`MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED` disputes. PayPal may use this in
case buyer denies the offer and requests buyer to return the item to
resolve the dispute.
description: You must specify the shipping address for
`MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED` disputes.
- name: UNKNOWN_ERROR
message: Unknown exception occurred.
description: An unknown error occurred.
- name: VALIDATION_ERROR
message: Invalid request - see details.
description: One or more validation errors occurred. See the details for
specific validation errors.
- name: REFUND_PREFERENCE_MUTUALLY_EXCLUSIVE
message: Invalid request - see details.
description: You should not provide preference for funding instrument and
provisional credit in same request. Any one preference should be passed
per request based on allowed_action_options.
- name: PROVISIONAL_CREDIT_PREFERENCE_NOT_ALLOWED
message: This action is not allowed for this dispute ID.
description: You cannot specify the provisional credit preference, As this
option not present in allowed_action_options.
- name: FUNDING_INSTRUMENT_PREFERENCE_NOT_ALLOWED
message: This action is not allowed for this dispute ID.
description: You cannot specify the refund funding instrument preference, As
this option not present in allowed_action_options.