> ## Documentation Index > Fetch the complete documentation index at: https://paypal-sb-staging.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Update or cancel tracking information for an order > Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:

AttributeOpNotes
itemsreplaceUsing replace op for items will replace the entire items object with the value sent in request.
notify_payerreplace, add
statusreplaceOnly patching status to CANCELLED is currently supported.
## OpenAPI ````yaml api-reference/checkout_orders_v2.json patch /v2/checkout/orders/{id}/trackers/{tracker_id} openapi: 3.0.3 info: title: Orders description: >- An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders. version: '2.28' contact: {} servers: - url: https://api-m.sandbox.paypal.com description: PayPal Sandbox Environment - url: https://api-m.paypal.com description: PayPal Live Environment security: [] tags: - name: orders description: >- Use the `/orders` resource to create, update, retrieve, authorize, capture and track orders. - name: trackers description: >- Use the `/trackers` resource to update and retrieve tracking information for PayPal orders. - name: externalcallback description: >- PayPal will use the callback url defined in the create order request to send merchants shipping address and shipping options data while the buyer is in the PayPal checkout. externalDocs: url: https://developer.paypal.com/docs/api/orders/v2/ paths: /v2/checkout/orders/{id}/trackers/{tracker_id}: patch: tags: - trackers summary: Update or cancel tracking information for an order description: >- Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:

AttributeOpNotes
itemsreplaceUsing replace op for items will replace the entire items object with the value sent in request.
notify_payerreplace, add
statusreplaceOnly patching status to CANCELLED is currently supported.
operationId: orders.trackers.patch parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/tracker_id' - $ref: '#/components/parameters/paypal_auth_assertion' requestBody: content: application/json: schema: $ref: '#/components/schemas/patch_request' examples: orders_patch_request: value: - op: replace path: /purchase_units/@reference_id=='PUHF'/shipping/address value: address_line_1: 2211 N First Street address_line_2: Building 17 admin_area_2: San Jose admin_area_1: CA postal_code: '95131' country_code: US responses: '204': description: >- A successful request returns the HTTP `204 No Content` status code with an empty object in the JSON response body. '400': description: >- Request is not well-formed, syntactically incorrect, or violates schema. content: application/json: schema: allOf: - $ref: '#/components/schemas/error_400' - $ref: '#/components/schemas/orders.trackers.patch-400' '403': description: Authorization failed due to insufficient permissions. content: application/json: schema: allOf: - $ref: '#/components/schemas/error_403' - $ref: '#/components/schemas/orders.trackers.patch-403' '404': description: The specified resource does not exist. content: application/json: schema: allOf: - $ref: '#/components/schemas/error_404' - $ref: '#/components/schemas/orders.trackers.patch-404' '422': description: >- The requested action could not be performed, semantically incorrect, or failed business validation. content: application/json: schema: allOf: - $ref: '#/components/schemas/error_422' - $ref: '#/components/schemas/orders.trackers.patch-422' '500': description: An internal server error has occurred. content: application/json: schema: $ref: '#/components/schemas/error_500' default: $ref: '#/components/responses/default' security: - Oauth2: - https://uri.paypal.com/services/payments/payment components: parameters: id: name: id in: path description: The ID of the order that the tracking information is associated with. required: true schema: type: string minLength: 1 maxLength: 36 pattern: ^[A-Z0-9]+$ tracker_id: name: tracker_id in: path description: The order tracking ID. required: true schema: type: string minLength: 1 maxLength: 36 pattern: ^[A-Z0-9]+$ paypal_auth_assertion: name: PayPal-Auth-Assertion in: header description: >- An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion. required: false schema: type: string schemas: 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' 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' orders.trackers.patch-400: properties: details: type: array items: anyOf: - title: FIELD_NOT_PATCHABLE properties: issue: type: string enum: - FIELD_NOT_PATCHABLE description: type: string enum: - Field cannot be patched. - title: INVALID_PARAMETER_VALUE properties: issue: type: string enum: - INVALID_PARAMETER_VALUE description: type: string enum: - The value of a field is invalid. - title: MISSING_REQUIRED_PARAMETER properties: issue: type: string enum: - MISSING_REQUIRED_PARAMETER description: type: string enum: - A required field or parameter is missing. - title: INVALID_STRING_LENGTH properties: issue: type: string enum: - INVALID_STRING_LENGTH description: type: string enum: - The value of a field is either too short or too long. - title: INVALID_PATCH_OPERATION properties: issue: type: string enum: - INVALID_PATCH_OPERATION description: type: string enum: - >- The operation cannot be honored. Cannot add a property that's already present, use replace. Cannot remove a property thats not present, use add. Cannot replace a property thats not present, use add. - title: MALFORMED_REQUEST_JSON properties: issue: type: string enum: - MALFORMED_REQUEST_JSON description: type: string enum: - The request JSON is not well formed. 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' orders.trackers.patch-403: properties: details: type: array items: anyOf: - title: PERMISSION_DENIED properties: issue: type: string enum: - PERMISSION_DENIED description: type: string enum: - >- You do not have permission to access or perform operations on this resource. 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' orders.trackers.patch-404: properties: details: type: array items: anyOf: - title: TRACKER_ID_NOT_FOUND properties: issue: type: string enum: - TRACKER_ID_NOT_FOUND description: type: string enum: - >- Specified tracker ID does not exist. Check the tracker ID and try again. 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' orders.trackers.patch-422: properties: details: type: array items: anyOf: - title: INVALID_JSON_POINTER_FORMAT properties: issue: type: string enum: - INVALID_JSON_POINTER_FORMAT description: type: string enum: - >- Path should be a valid [JSON Pointer](https://tools.ietf.org/html/rfc6901) that references a location within the request where the operation is performed. - title: NOT_PATCHABLE properties: issue: type: string enum: - NOT_PATCHABLE description: type: string enum: - Cannot be patched. - title: PATCH_VALUE_REQUIRED properties: issue: type: string enum: - PATCH_VALUE_REQUIRED description: type: string enum: - Specify a `value` for the field being patched. - title: PATCH_PATH_REQUIRED properties: issue: type: string enum: - PATCH_PATH_REQUIRED description: type: string enum: - >- Specify a `value` for the field in which the operation needs to be performed. - title: ITEM_SKU_MISMATCH properties: issue: type: string enum: - ITEM_SKU_MISMATCH description: type: string enum: - >- Item sku must match one of the items sku that was provided during order creation. - title: MAX_TRACKER_UPDATE_COUNT_EXCEEDED properties: issue: type: string enum: - MAX_TRACKER_UPDATE_COUNT_EXCEEDED description: type: string enum: - >- Exceeding the permissible number of updates; tracker update operations do not support more than 15 updates. error_500: type: object title: Internal Server Error description: >- This is either a system or application error, and generally indicates that although the client appeared to provide a correct request, something unexpected has gone wrong on the server. properties: name: type: string enum: - INTERNAL_SERVER_ERROR message: type: string enum: - An internal server error occurred. debug_id: type: string description: The PayPal internal ID. Used for correlation purposes. links: description: >- An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS). type: array minItems: 0 maxItems: 10000 items: $ref: '#/components/schemas/error_link_description' example: name: INTERNAL_SERVER_ERROR message: An internal server error occurred. debug_id: 90957fca61718 links: - href: >- https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR rel: information_link patch: type: object title: Patch description: The JSON patch object to apply partial updates to resources. properties: op: type: string description: The operation. x-enumDescriptions: - value: add description: >- Depending on the target location reference, completes one of these functions:The value parameter defines the value to add. For more information, see 4.1. add. - value: remove description: >- Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove. - value: replace description: >- Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace. - value: move description: >- Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move. - value: copy description: >- Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy. - value: test description: >- Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
TypeConsidered equal if both values
stringsContain the same number of Unicode characters and their code points are byte-by-byte equal.
numbersAre numerically equal.
arraysContain 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.
objectsContain 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.
For more information, see 4.6. test. enum: - add - remove - replace - move - copy - test path: type: string description: >- The JSON Pointer to the target document location at which to complete the operation. value: title: Patch Value description: >- The value to apply. The 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 error_details: title: Error Details type: object description: The error details. Required for client-side `4XX` errors. properties: field: type: string description: >- The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. value: type: string description: The value of the field that caused the error. location: $ref: '#/components/schemas/error_location' issue: type: string description: The unique, fine-grained application-level error code. description: type: string description: >- The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. required: - issue error_link_description: title: Link Description description: >- The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information. type: object required: - href - rel properties: href: description: >- The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call. type: string minLength: 0 maxLength: 20000 pattern: ^.*$ rel: description: >- The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml). type: string minLength: 0 maxLength: 100 pattern: ^.*$ method: description: The HTTP method required to make the related call. type: string minLength: 3 maxLength: 6 pattern: ^[A-Z]*$ enum: - GET - POST - PUT - DELETE - PATCH error_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_429' - $ref: '#/components/schemas/error_500' - $ref: '#/components/schemas/error_503' 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 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_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_429: type: object title: Too many requests description: Too many requests. Blocked due to rate limiting. properties: name: type: string enum: - RATE_LIMIT_REACHED message: type: string enum: - Too many requests. Blocked due to rate limiting. debug_id: type: string description: The PayPal internal ID. Used for correlation purposes. error_503: type: object title: Service Unavailable Error description: >- The server is temporarily unable to handle the request, for example, because of planned maintenance or downtime. properties: name: type: string enum: - SERVICE_UNAVAILABLE message: type: string enum: - Service Unavailable. debug_id: type: string description: The PayPal internal ID. Used for correlation purposes. links: description: >- An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS). type: array minItems: 0 maxItems: 10000 items: $ref: '#/components/schemas/error_link_description' example: name: SERVICE_UNAVAILABLE message: Service Unavailable. debug_id: 90957fca61718 information_link: >- https://developer.paypal.com/docs/api/orders/v2/#error-SERVICE_UNAVAILABLE responses: default: description: The default response. content: application/json: schema: $ref: '#/components/schemas/error_default' securitySchemes: Oauth2: type: oauth2 description: Oauth 2.0 authentication flows: clientCredentials: tokenUrl: /v1/oauth2/token scopes: https://uri.paypal.com/services/payments/payment: Manage payments and checkout workflow. https://uri.paypal.com/services/payments/payment/reference-transaction: Permission to initiate reference transaction https://uri.paypal.com/services/payments/initiatepayment: Initiates payments and checkout workflows. https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants: >- Allows client-side integration on Create, Get, Patch, Authorize & Capture Order endpoints. https://uri.paypal.com/services/payments/orders/client_sdk_orders_api: >- Enables secure client-side integration on confirm payment source endpoint ````