Skip to main content

Documentation Portal

Data

Parameter Name	Type	Description	Mandatory
`GlobaleRMANumber`	String	The Global-e return merchandise authorization (RMA) Number. Maximum 100 characters.
`MerchantOrderId`	String	The Merchant Order ID. Maximum 100 characters.
`MerchantRMANumber`	String	The Merchant RMA Number Maximum 100 characters.
`OrderId`	String	The Global-e Order ID. Maximum 100 characters.
`ReturnDocuments`	Object `ReturnDocuments`	Object `ReturnDocuments` provides documents associated with returns. `ReturnDocuments` returns the following documents individually or unified, as a single multi-page document, including: Commercial Invoice (if the electronic invoice is not supported) Shipping Label Return Note
`ReturnTrackingDetails`	Object `ReturnTrackingDetails`	Object `ReturnTrackingDetails` contains tracking details for returns.

ReturnDocuments

The ReturnDocuments returns the following documents individually or unified, as a single multi-page document, including:

Commercial Invoice (if the electronic invoice is not supported)
Shipping Label
Return Note

Parameter Name	Type	Description	Mandatory
`DocumentData`	String	Base64 file type representing the document file content
`DocumentTypeCode`	String	The code value of the document type. This value can be: ShippingLabel ReturnNote CommercialInvoice CombinedReturnDocuments (if UnifiedAllDocumentsUnderOneFile = true) Each document contains the relevant content and with relevant copies. Examples: The return note PDF has only the return note without additional documents. The ReturnCommercialInvoice should have the return commercial invoice with the correct number of copies.
`DocumentTypeName`	String	The name of the document type, e.g. ShippingLabel, ReturnNote or CommercialInvoice (unless the invoice is electronic, no invoice is returned).
`URL`	String	URL of the document

ReturnTrackingDetails

Parameter Name	Type	Description	Mandatory
`IsQrLabel`	String	Identifies whether this is a label-free return (QR code only). This information also applied to the ShippingLabel object	No
`IsTrackable`	String	Identifies whether this is a trackable return	No
`ShipperName`	String	The name of the Shipping Service of the return provider	Yes
`TrackingNumber`	String	Reference number for the tracking service used by the shipper for this return	Yes
`TrackingURL`	String	Tracking URL of the tracking service site used by the shipper	Yes

Would you like to provide feedback? Just click here to suggest edits.