1
0
Files
PayPal-PHP-Server-SDK/doc/models/order-tracker-response.md
2025-05-27 17:46:31 +00:00

2.8 KiB

Order Tracker Response

The tracking response on creation of tracker.

Structure

OrderTrackerResponse

Fields

Name Type Tags Description Getter Setter
id ?string Optional The tracker id. getId(): ?string setId(?string id): void
status ?string(OrderTrackerStatus) Optional The status of the item shipment.

Constraints: Minimum Length: 1, Maximum Length: 64, Pattern: ^[0-9A-Z_]+$
getStatus(): ?string setStatus(?string status): void
items ?(OrderTrackerItem[]) Optional An array of details of items in the shipment. getItems(): ?array setItems(?array items): void
links ?(LinkDescription[]) Optional An array of request-related HATEOAS links. getLinks(): ?array setLinks(?array links): void
createTime ?string Optional The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Constraints: Minimum Length: 20, Maximum Length: 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})$
getCreateTime(): ?string setCreateTime(?string createTime): void
updateTime ?string Optional The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Constraints: Minimum Length: 20, Maximum Length: 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})$
getUpdateTime(): ?string setUpdateTime(?string updateTime): void

Example (as JSON)

{
  "id": "id2",
  "status": "CANCELLED",
  "items": [
    {
      "name": "name8",
      "quantity": "quantity4",
      "sku": "sku6",
      "url": "url2",
      "image_url": "image_url4"
    },
    {
      "name": "name8",
      "quantity": "quantity4",
      "sku": "sku6",
      "url": "url2",
      "image_url": "image_url4"
    }
  ],
  "links": [
    {
      "href": "href6",
      "rel": "rel0",
      "method": "HEAD"
    },
    {
      "href": "href6",
      "rel": "rel0",
      "method": "HEAD"
    },
    {
      "href": "href6",
      "rel": "rel0",
      "method": "HEAD"
    }
  ],
  "create_time": "create_time8"
}