âŦī¸Request and Response
Request to the API endpoint
Last updated
Request to the API endpoint
Last updated
POST
https://api.alephcrm.com/v2/orders/{orderId}/documents
Name | Type | Description |
---|---|---|
There are two different ways of attaching the document: through form-data, or through JSON body with a base64-encoded file.
This is the most common way, and the endpoint expects to receive the following parameters using URL_PARAM (via query string) parameters and values. See example here.
This is the easiest way, and the endpoint expects to receive the following parameters using URL_PARAM (via query string) parameters and values one JSON object in the BODY with some attributes, including a base64-encoded file. See example here.
The API_KEY that was provided.
The Alephee account ID of the orders you are trying to get.
Alephee ID to identify the order. The Alephee order number. It is not the marketplace order number.
Document file to attach into an order.
The document to attach into an order. Must be an encoded base64 string of the document´s full content.
Document name, only for base64 encoded files
Document extension, only for base64 encoded files
Type of document to attach. Available values are:
0 = Invoice
1 = Receipt
2 = Electronic fiscal invoice (exclusive for Brazilian customers)
This parameter is extremely important. Invoices and electronic fiscal invoices are sent to the orderâs origin marketplace. Receipts donât.
Internal number for the document
The date the document was issued.
This field is to specify a text message that will travel with the attached file.
Fiscal key of the electronic invoice
Series number of the electronic invoice
API_KEY*
String
(default=none)
accountId *
Integer
(default=none)
orderId
Integer
Internal Alephee's order ID. It is NOT the marketplace-assigned order number.
file
File
fileBase64
String
documentName
String
documentExtension
String
documentType
Integer
documentNumber
String
documentDate
Datetime
messageText
String
fiscalKey
String
seriesNumber
String