Return Registrations
Our API allows you to create, update, and retrieve customer return registrations.
Overview
Get Return Registrations
The pagination cursor value.
Which field to use when ordering the results.
http://api.example.org/accounts/?cursor=cD00ODY%3D"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3Get a Return Registration
Unique identifier for this return registration, generated by parcelLab
Represents a return registration
Account, that is linked to this registration.
Configuration code of the return configuration
Name of the client, as configured in account setup.
Retailer reference, e.g. the order number, not unique
Unique identifier for this return registration, generated by parcelLab
Additional identifier (e.g. shop system id) for this return registration, generated by the retailer
If true, the registration has been submitted. This is a read-only field.
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
Reason for the current status
Date of the order
Currency of the order, e.g. USD, EUR (ISO 4217)
Total amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total shipping amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total tax amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Date of the order delivery
Date of the order shipment
Payment method used for the order, as setup as reference items in the accounts configuration
ISO 639-1 language code of the recipient, if known, required for localized communication
Customers email address, must be provided, in case email is not known or should be unset, use the literal string '_unset' instead.
Customer phone number
ISO 3166-1 alpha-3 code of country
Refund method selected by customer
Order level tags.
Additional fields for the return registration
Verification code (e.g. zip/email) used for this return registration
Create a Return Registration
Set to true to use the test environment for carrier integration.
falseSet to true to preview behavior using unpublished configuration changes (e.g., article rules or courier options).
falseRepresents a return registration
Account, that is linked to this registration.
Configuration code of the return configuration
Retailer reference, e.g. the order number, not unique
Unique identifier for this return registration, generated by parcelLab
Additional identifier (e.g. shop system id) for this return registration, generated by the retailer
If true, the registration has been submitted. This is a read-only field.
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
Reason for the current status
Date of the order
Currency of the order, e.g. USD, EUR (ISO 4217)
Total amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total shipping amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total tax amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Date of the order delivery
Date of the order shipment
Payment method used for the order, as setup as reference items in the accounts configuration
ISO 639-1 language code of the recipient, if known, required for localized communication
Customers email address, must be provided, in case email is not known or should be unset, use the literal string '_unset' instead.
Customer phone number
ISO 3166-1 alpha-3 code of country
Refund method selected by customer
Order level tags.
Additional fields for the return registration
Verification code (e.g. zip/email) used for this return registration
Create a Return Registration via Order Information
The account ID to create this return registration on.
Configuration code (unique identifier of the return portal or configuration used for this return
Represents a return registration
Account, that is linked to this registration.
Configuration code of the return configuration
Name of the client, as configured in account setup.
Retailer reference, e.g. the order number, not unique
Unique identifier for this return registration, generated by parcelLab
Additional identifier (e.g. shop system id) for this return registration, generated by the retailer
If true, the registration has been submitted. This is a read-only field.
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
Reason for the current status
Date of the order
Currency of the order, e.g. USD, EUR (ISO 4217)
Total amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total shipping amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total tax amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Date of the order delivery
Date of the order shipment
Payment method used for the order, as setup as reference items in the accounts configuration
ISO 639-1 language code of the recipient, if known, required for localized communication
Customers email address, must be provided, in case email is not known or should be unset, use the literal string '_unset' instead.
Customer phone number
ISO 3166-1 alpha-3 code of country
Refund method selected by customer
Order level tags.
Additional fields for the return registration
Verification code (e.g. zip/email) used for this return registration
Update a Return Registration
Unique identifier for this return registration, generated by parcelLab
Represents a return registration
Account, that is linked to this registration.
Configuration code of the return configuration
Retailer reference, e.g. the order number, not unique
Unique identifier for this return registration, generated by parcelLab
Additional identifier (e.g. shop system id) for this return registration, generated by the retailer
If true, the registration has been submitted. This is a read-only field.
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
Reason for the current status
Date of the order
Currency of the order, e.g. USD, EUR (ISO 4217)
Total amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total shipping amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total tax amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Date of the order delivery
Date of the order shipment
Payment method used for the order, as setup as reference items in the accounts configuration
ISO 639-1 language code of the recipient, if known, required for localized communication
Customers email address, must be provided, in case email is not known or should be unset, use the literal string '_unset' instead.
Customer phone number
ISO 3166-1 alpha-3 code of country
Refund method selected by customer
Order level tags.
Additional fields for the return registration
Verification code (e.g. zip/email) used for this return registration
Represents a return registration
Account, that is linked to this registration.
Configuration code of the return configuration
Name of the client, as configured in account setup.
Retailer reference, e.g. the order number, not unique
Unique identifier for this return registration, generated by parcelLab
Additional identifier (e.g. shop system id) for this return registration, generated by the retailer
If true, the registration has been submitted. This is a read-only field.
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
Reason for the current status
Date of the order
Currency of the order, e.g. USD, EUR (ISO 4217)
Total amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total shipping amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total tax amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Date of the order delivery
Date of the order shipment
Payment method used for the order, as setup as reference items in the accounts configuration
ISO 639-1 language code of the recipient, if known, required for localized communication
Customers email address, must be provided, in case email is not known or should be unset, use the literal string '_unset' instead.
Customer phone number
ISO 3166-1 alpha-3 code of country
Refund method selected by customer
Order level tags.
Additional fields for the return registration
Verification code (e.g. zip/email) used for this return registration
Partially Update a Return Registration
Unique identifier for this return registration, generated by parcelLab
Represents a return registration
Account, that is linked to this registration.
Configuration code of the return configuration
Retailer reference, e.g. the order number, not unique
Unique identifier for this return registration, generated by parcelLab
Additional identifier (e.g. shop system id) for this return registration, generated by the retailer
If true, the registration has been submitted. This is a read-only field.
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
Reason for the current status
Date of the order
Currency of the order, e.g. USD, EUR (ISO 4217)
Total amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total shipping amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total tax amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Date of the order delivery
Date of the order shipment
Payment method used for the order, as setup as reference items in the accounts configuration
ISO 639-1 language code of the recipient, if known, required for localized communication
Customers email address, must be provided, in case email is not known or should be unset, use the literal string '_unset' instead.
Customer phone number
ISO 3166-1 alpha-3 code of country
Refund method selected by customer
Order level tags.
Additional fields for the return registration
Verification code (e.g. zip/email) used for this return registration
Represents a return registration
Account, that is linked to this registration.
Configuration code of the return configuration
Name of the client, as configured in account setup.
Retailer reference, e.g. the order number, not unique
Unique identifier for this return registration, generated by parcelLab
Additional identifier (e.g. shop system id) for this return registration, generated by the retailer
If true, the registration has been submitted. This is a read-only field.
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
Reason for the current status
Date of the order
Currency of the order, e.g. USD, EUR (ISO 4217)
Total amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total shipping amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total tax amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Date of the order delivery
Date of the order shipment
Payment method used for the order, as setup as reference items in the accounts configuration
ISO 639-1 language code of the recipient, if known, required for localized communication
Customers email address, must be provided, in case email is not known or should be unset, use the literal string '_unset' instead.
Customer phone number
ISO 3166-1 alpha-3 code of country
Refund method selected by customer
Order level tags.
Additional fields for the return registration
Verification code (e.g. zip/email) used for this return registration
Modify a Return Registration
Unique identifier for this return registration, generated by parcelLab
Update (mutate) a return registration
Represents a return registration
Account, that is linked to this registration.
Configuration code of the return configuration
Name of the client, as configured in account setup.
Retailer reference, e.g. the order number, not unique
Unique identifier for this return registration, generated by parcelLab
Additional identifier (e.g. shop system id) for this return registration, generated by the retailer
If true, the registration has been submitted. This is a read-only field.
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
Reason for the current status
Date of the order
Currency of the order, e.g. USD, EUR (ISO 4217)
Total amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total shipping amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total tax amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Date of the order delivery
Date of the order shipment
Payment method used for the order, as setup as reference items in the accounts configuration
ISO 639-1 language code of the recipient, if known, required for localized communication
Customers email address, must be provided, in case email is not known or should be unset, use the literal string '_unset' instead.
Customer phone number
ISO 3166-1 alpha-3 code of country
Refund method selected by customer
Order level tags.
Additional fields for the return registration
Verification code (e.g. zip/email) used for this return registration
Modify Return Registrations
Update (mutate) a return registration
Represents a return registration
Account, that is linked to this registration.
Configuration code of the return configuration
Name of the client, as configured in account setup.
Retailer reference, e.g. the order number, not unique
Unique identifier for this return registration, generated by parcelLab
Additional identifier (e.g. shop system id) for this return registration, generated by the retailer
If true, the registration has been submitted. This is a read-only field.
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
created- Createdsubmitted- Submittedpending_approval- Pending Approvalpending_label- Pending Labelapproved- Approvedrejected- Rejectedcancelled- Cancelledclosed- Closedprocessing_failed- Processing Failed
Reason for the current status
Date of the order
Currency of the order, e.g. USD, EUR (ISO 4217)
Total amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total shipping amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Total tax amount of the original order
^-?\d{0,8}(?:\.\d{0,2})?$Date of the order delivery
Date of the order shipment
Payment method used for the order, as setup as reference items in the accounts configuration
ISO 639-1 language code of the recipient, if known, required for localized communication
Customers email address, must be provided, in case email is not known or should be unset, use the literal string '_unset' instead.
Customer phone number
ISO 3166-1 alpha-3 code of country
Refund method selected by customer
Order level tags.
Additional fields for the return registration
Verification code (e.g. zip/email) used for this return registration
Get Returns Article Information
Unique identifier for this return registration, generated by parcelLab
Set to true to preview behavior using unpublished configuration changes (e.g., article rules or courier options).
falseTrue if split returns is enabled and there are multiple groups to choose from
falsePartially Update Returns Article Information
Unique identifier for this return registration, generated by parcelLab
Set to true to preview behavior using unpublished configuration changes (e.g., article rules or courier options).
falseUpdate the selection of articles for a return registration
Whether to commit the changes to the return registration (defaults to false, convenience flag clients)
falseTrue if split returns is enabled and there are multiple groups to choose from
falseGet Return Options
Unique identifier for this return registration, generated by parcelLab
Set to true to preview behavior using unpublished configuration changes (e.g., article rules or courier options).
falseOption (Courier) Code that this translation is for (i.e. code of Courier API config). Use 'default' for general translations that apply to any code that does not have a specialized translation.
""Optional - identifier from Courier API if specialized description is required.
""Title shown in return option (courier) selection box
""Description shown in return option (courier) selection box
""Instructions for downloading and using the return label when it is combined with the packing slip.
""Instructions for downloading and using the return label when it is separate from the packing slip.
""Text for the button to download the return label.
""Instructions shown for downloading the packing slip when it is separate from the label.
""Text for the button to download the packing slip when it is separate from the label.
""Instructions for using the QR code.
""Text for the button to download the QR code.
""nullThis translation group uses default values
Assign Return Options
Unique identifier for this return registration, generated by parcelLab
Was this helpful?