v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

return

Query Return Packages

Query all packages for a specific return

get/v2/returns/{returnId}/packages

Path parameters

returnIdstring uuid required

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the return that the packages belong to.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

The requested packages.

idstring uuid

returnIdstring uuid

trackingIDstring

The tracking Id of the package.

shippingMethodIdstring uuid

shippingMethodCustomstring

The custom shipping method name used for the return. This value may only be set if ShippingMethodId is not provided.

Example response

[
  {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "returnId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
]