⬆️Request and Response

Request to the API endpoint

Retrieves a list of orders that meet the specified criteria

GET https://api.alephcrm.com/v2/orders/{orderId}/shippinglabel

Query Parameters

Name	Type	Description
API_KEY*	String	(default=none)
accountId *	Integer	(default=none)
base64	Boolean
format*	String

200: OK File or base64 encoded string with the requested shipping label

400: Bad Request {"Status": integer, "Message": string}

401: Unauthorized {"Status": integer, "Message": string}

403: Forbidden {"Status": integer, "Message": string}

404: Not Found {"Status": integer, "Message": string}

412: Precondition Failed {"Status": integer, "Message": string}

429: Too Many Requests {"Status": integer, "Message": string}

500: Internal Server Error String

Parameters details

API_KEY

The API_KEY that was provided.

accountId

The Alephee account ID of the shipping label you are trying to get.

orderId

Alephee ID to identify the order. The Alephee order number. It is not the marketplace order number.

format

Specify the download format of the requested shipping label. Available values are “TXT” or “ZIP” or “PDF” format. TXT: Generates the shipping label in the ZPL format (for Zebra printers) in a downloadable “.txt” file. ZIP: Generates the shipping label in the ZPL format (for Zebra printers) and complementary .PDF file with the marketplace’s control receipt, both contained in a compressed and downloadable “.zip” file. PDF: Generates the shipping label in a .PDF format (for standard printers) in a downloadable “.pdf” file.

base64

Forces downloading shipping label in the selected format but encoded as a base64 string.