PAparcellab
Return Registration

List Return Registration

Changed on

Return Registrations represent a return request from a customer. There might be multiple return registrations for a single order. There might also be multiple labels for one return registration, if requested by the customer.

A return registration is linked to a configuration bundle (field 'code'), multiple configurations might be available on one account (e.g. country-specific courier configurations).

Return registrations are created by the parcelLab return portal, or by the retailer via the parcelLab API.

Certain fields of the return registration are not mutable via requests on the registration resource, but require 'action' payloads to be submitted (e.g. 'AddLabel') to the 'mutate' action.

get/v4/returns/return-registrations/

Request

  • The document declares no server URL.
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

accountinteger[]
clientinteger[]

Multiple values may be separated by commas.

compensation_methodstring[]

Multiple values may be separated by commas.

courierstring[]

Multiple values may be separated by commas.

created_at_afterstring date-time
created_at_beforestring date-time
creation_methodstring[]

Describes the method used to create this return registration

  • self_registration - Self registration
  • existing_order - Existing order
cursorstring

The pagination cursor value.

customer_country_iso3string[]

Multiple values may be separated by commas.

customer_emailstring
customer_postal_codestring
external_idstring uuid
external_referencestring
is_pickupboolean
language_iso2string[]

Multiple values may be separated by commas.

limitinteger

Number of results to return per page.

order_date_afterstring date-time
order_date_beforestring date-time
orderingstring

Order results by any response field. Prefix with - for descending (e.g. -id).

original_order_idstring
referencestring
refund_methodstring[]

Multiple values may be separated by commas.

return_idinteger
return_reasonstring
return_reason_prettystring[]

Repeat this parameter to filter by multiple pretty return reasons.

returns_portal_codestring[]

Multiple values may be separated by commas.

searchstring
statusstring[]
  • created - Created
  • pending_payment - Pending Payment
  • submitted - Submitted
  • pending_approval - Pending Approval
  • pending_label - Pending Label
  • approved - Approved
  • rejected - Rejected
  • cancelled - Cancelled
  • closed - Closed
  • processing_failed - Processing Failed
  • invalid - Invalid
status_notstring[]
  • created - Created
  • pending_payment - Pending Payment
  • submitted - Submitted
  • pending_approval - Pending Approval
  • pending_label - Pending Label
  • approved - Approved
  • rejected - Rejected
  • cancelled - Cancelled
  • closed - Closed
  • processing_failed - Processing Failed
  • invalid - Invalid
tagsstring
tracking_numberstring
updated_at_afterstring date-time
updated_at_beforestring date-time

Response

nextstring uri nullable
previousstring uri nullable

Example response

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "articles_order": [
        {
          "article_name": "Blue T-Shirt",
          "line_item_id": "ITEM-001",
          "product_id": "PROD-123",
          "quantity": 2,
          "sku": "TSHIRT-BLUE-M"
        }
      ],
      "articles_return": [
        {
          "article_name": "Blue T-Shirt",
          "line_item_id": "ITEM-001",
          "product_id": "PROD-123",
          "quantity": 2,
          "sku": "TSHIRT-BLUE-M"
        }
      ],
      "mutations": [
        {
          "items": [
            {
              "article_name": "Blue T-Shirt",
              "line_item_id": "ITEM-001",
              "product_id": "PROD-123",
              "quantity": 2,
              "sku": "TSHIRT-BLUE-M"
            }
          ]
        }
      ]
    }
  ]
}

Changes