⚙️Examples

Request:

curl --location --request GET 'https://api.alephcrm.com/v2/orders?API_KEY=AAAAAAAA-XXX-XXX-XXX-XXXXXXXXXXXX&accountID=NNNN&integrated=false \
--header 'Content-Type: application/json' \
--header 'Cookie: xxx' \

Responses:

GET orders example:
{
   "Paging":{
      "Limit":1,
      "Offset":0,
      "Total":1
   },
   "AvailableSorts":[
      {
         "Id":"Id",
         "Name":"Order by internal ID asc"
      },
      {
         "Id":"dateCreated",
         "Name":"Order by date of sale asc"
      }
   ],
   "Total":1,
   "Results":[
      {
         "Id":58X52,
         "SellerAccount":{
            "Id":11111111,
            "Name":"Razon social",
            "BusinessName":"Nombre de fantasía"
         },
         "ExternalOrderId":"20X034X460",
         "IntegratedOrderId":"",
         "PackId":"",
         "Items":[
            {
               "Id":61745,
               "Product":{
                  "Id":183X76,
                  "Sku":"PX2000TX-AR",
                  "Brand":"Black + Decker",
                  "SellerSku":"",
                  "EAN":"885X11407519",
                  "Title":"Hidrolavadora 2000W",
                  "IntegrationCode":"MLA785X40296",
                  "Category":{
                     "Key":"MLA3X840",
                     "Value":"Hidrolavadoras"
                  }
               },
               "ProductListing":{
                  "Id":5097398,
                  "ExternalId":"MLA3X8409928",
                  "Title":"Super oferta de Hidrolavadora 2000W",
                  "ListingType":{
                     "Key":7,
                     "Value":"free"
                  },
                  "PermanentLink":"https://articulo.mercadolibre.com.ar/MLA-83XXXXX/masinfo_JM"
               },
               "Quantity":2,
               "UnitPrice":1135.83,
               "Status":{
                  "Key":90,
                  "Value":"Cancelado"
               },
               "StatusType":{
                  "Key":99,
                  "Value":"Cancelado"
               },
               "Type":{
                  "Key":0,
                  "Value":"Product"
               },
               "IsCancelled":true
            }
         ],
         "Payments":[
            {
               "ExternalPaymentId":474X41X716,
               "Amount":1967.17,
               "AmountNoDiscount":1967.17,
               "ShippingAmount":0.0,
               "ShippingAmountNoDiscount":0.0,
               "Installments":1,
               "Notes":"Hidrolavadora 2000w",
               "CurrencySymbol":"ARS",
               "Method":{
                  "Key":0,
                  "Value":"account_money"
               },
               "Status":{
                  "Key":1,
                  "Value":"approved - accredited"
               },
               "Taxes":{
                  
               },
               "DateCreated":"2019-05-08T22:42:58Z",
               "DateApproved":"2019-05-08T22:43:04Z",
               "LastUpdate":"2019-05-08T22:43:04Z"
            },
            {
               "ExternalPaymentId":4749562101,
               "Amount":304.49,
               "AmountNoDiscount":304.49,
               "ShippingAmount":0.0,
               "ShippingAmountNoDiscount":0.0,
               "Installments":1,
               "InstallmentAmount":304.49,
               "Notes":"Hidrolavadora 2000w 150bar Black Decker PX2000tx",
               "CurrencySymbol":"ARS",
               "Method":{
                  "Key":5,
                  "Value":"debvisa"
               },
               "Status":{
                  "Key":1,
                  "Value":"approved - accredited"
               },
               "Taxes":{
                  
               },
               "AuthorizationCode":"257857",
               "DateCreated":"2019-05-08T22:42:59Z",
               "DateApproved":"2019-05-08T22:43:04Z",
               "LastUpdate":"2019-05-08T22:43:04Z"
            }
         ],
         "Shipping":{
            "ExternalShippingId":28X8798X85,
            "Method":{
               "Key":1,
               "Value":"Mercado Envios"
            },
            "Status":{
               "Key":80,
               "Value":"delivered"
            },
            "LogisticType":{
               "Key":3,
               "Value":"me2"
            },
            "ShippingLabels":{
               "ShippingLabelUrlPdf":"",
               "ShippingLabelUrlZip":""
            },
            "ReceiverAddress":{
               "CountryId":"AR",
               "StreetName":"9",
               "StreetNumber":"XXXX",
               "ZipCode":"6660",
               "Description":"9 XXXX, - (6660)"
            },
            "Receiver":{
               "Name":"Paz XXXX",
               "Phone":"5X492X54499X8"
            },
            "EstimatedDeliveryDate":"2020-01-02T03:00:00Z",
            "DateCreated":"2019-09-01T22:53:32Z",
            "LastUpdated":"2019-09-06T17:47:08Z"
         },
         "Buyer":{
            "Name":"MAURICIO HECTOR XXXX",
            "Phone":"35X34010X95",
            "Email":"gerenc.920iydcmbtgq4tkmju@mail.mercadolibre.com",
            "DocType":"DNI",
            "DocNumber":"2X334X54",
            "BillingInfo":{
               "DocType":"DNI",
               "DocNumber":"2X334X54",
               "Address":{
                  "City":"las varillas",
                  "State":"Córdoba",
                  "CountryId":"AR",
                  "StreetName":"Corrientes",
                  "StreetNumber":"3X9",
                  "ZipCode":"5X40",
                  "Notes":"cavallo",
                  "Description":"Corrientes 3X9, las varillas - Córdoba (5940)"
               }
            },
            "Address":{
               "City":"Las varillas",
               "State":"AR-X",
               "CountryId":"AR",
               "Phone":"",
               "AlternativePhone":""
            }
         },
         "Integrated":true,
         "Status":{
            "Key":90,
            "Value":"Cancelado"
         },
         "StatusType":{
            "Key":99,
            "Value":"Cancelado"
         },
         "MarketPlace":{
            "Key":1,
            "Value":"Mercado Libre",
			"Channel": ""
         },
         "DateCreated":"2019-05-08T22:42:57Z",
         "LastUpdated":"2019-05-08T22:43:04Z",
         "DateClosed":"2019-05-08T22:43:04Z",
         "IsCancelled":true
      }
   ]
}
GET orders example with a KIT-type product:
{
	"Paging": {
		"Limit": 100,
		"Offset": 0,
		"Total": 1
	},
	"AvailableSorts": [
		{
			"Id": "Id",
			"Name": "Order by internal ID asc"
		},
		{
			"Id": "dateCreated",
			"Name": "Order by date of sale asc"
		}
	],
	"Total": 1,
	"Results": [
		{
			"Id": 100000,
			"ExternalOrderId": "4000000000",
			"PackId": "",
			"SellerAccount": {
				"Id": 00000,
				"Name": "Tienda de prueba",
				"BusinessName": "Tienda de prueba"
			},
			"Items": [
				{
					"Id": 1384025,
					"Type": {
						"Key": 1,
						"Value": "Kit"
					},
					"Product": {
						"Id": 2012445,
						"Sku": "1000000-02",
						"Brand": "Firestone",
						"SellerSku": "",
						"EAN": "",
						"Title": "F-700",
						"IntegrationCode": "MLB190000000",
						"Category": {
							"Key": "MLB2233",
							"Value": "Pneus de Carros e Caminhonetes"
						}
					},
					"ProductListing": {
						"Id": 1600000,
						"ExternalId": "MLB10000000",
						"Title": "F-700 Firestone",
						"ListingType": {
							"Key": 32,
							"Value": "gold_special"
						},
						"PermanentLink": "https://produto.mercadolivre.com.br/MLB-190000000-f-700-firestone-_JM"
					},
					"Quantity": 1,
					"UnitPrice": 8000.0,
					"FullUnitPrice": 8000.0,
					"UnitPriceCost": 0.0,
					"CalculatedComponentUnitPrice": 0.0,
					"CalculatedComponentFullUnitPrice": 0.0,
					"SaleFee": 920.0,
					"Status": {
						"Key": 10,
						"Value": "A preparar"
					},
					"StatusType": {
						"Key": 1,
						"Value": "Pendiente"
					},
					"IsCancelled": false
				},
				{
					"Id": 1384026,
					"Type": {
						"Key": 2,
						"Value": "Component"
					},
					"ParentItemId": 1384025,
					"Product": {
						"Id": 2012443,
						"Sku": "10000000",
						"Brand": "Firestone",
						"SellerSku": "",
						"EAN": "",
						"Title": "F-700",
						"IntegrationCode": "",
						"Category": {
							"Key": "MLB2233",
							"Value": "Pneus de Carros e Caminhonetes"
						}
					},
					"ProductListing": {
						"ListingType": {
							"Key": 0
						}
					},
					"Quantity": 2,
					"UnitPrice": 0.0,
					"FullUnitPrice": 0.0,
					"UnitPriceCost": 0.0,
					"CalculatedComponentUnitPrice": 4000.0,
					"CalculatedComponentFullUnitPrice": 4000.0,
					"Status": {
						"Key": 10,
						"Value": "A preparar"
					},
					"StatusType": {
						"Key": 1,
						"Value": "Pendiente"
					},
					"IsCancelled": false
				}
			],
			"Payments": [
				{
					"ExternalPaymentId": "100000000",
					"Amount": 8165.91,
					"AmountNoDiscount": 8165.91,
					"ShippingAmount": 165.91,
					"ShippingAmountNoDiscount": 165.91,
					"TransactionAmount": 8000.0,
					"Installments": 1,
					"InstallmentAmount": 8165.91,
					"Notes": "F-700 Firestone",
					"CurrencySymbol": "BRL",
					"Method": {
						"Key": 4,
						"Value": "elo"
					},
					"Status": {
						"Key": 1,
						"Value": "approved - accredited"
					},
					"Taxes": {},
					"AuthorizationCode": "1234567",
					"DateCreated": "2021-07-01T21:21:25Z",
					"DateApproved": "2021-07-01T21:21:25Z",
					"LastUpdate": "2021-07-01T21:22:31Z"
				}
			],
			"Shipping": {
				"ExternalShippingId": 400000000,
				"Cost": 165.91,
				"ReceiverCost": 165.91,
				"SenderCost": 0.0,
				"Method": {
					"Key": 3,
					"Value": "Mercado Envios"
				},
				"Status": {
					"Key": 10,
					"Value": "pending"
				},
				"LogisticType": {
					"Key": 2,
					"Value": "Mercado Envios 1"
				},
				"ShippingLabels": {
					"SubStatus": "pending",
					"ShippingLabelUrlPdf": "",
					"ShippingLabelUrlZip": ""
				},
				"ReceiverAddress": {
					"CountryId": "BR",
					"StateCode": "BR-SP",
					"State": "São Paulo",
					"City": "Campinas",
					"Neighborhood": "Mansões Santo Antônio",
					"StreetName": "Rua Adelino Martins",
					"StreetNumber": "0000",
					"ZipCode": "000000",
					"Notes": "",
					"Description": "Rua Adelino Martins 0000, Campinas - São Paulo (000000)"
				},
				"Receiver": {
					"Name": "TEST TEST",
					"Phone": "19987893219"
				},
				"DateCreated": "2021-07-01T21:21:25Z",
				"LastUpdated": "2021-07-01T21:21:28Z"
			},
			"Buyer": {
				"Code": 0,
				"Name": "Test Test",
				"Phone": "(01) 1111-1111 ",
				"Email": "ttest.554f2t+2-ogq3dqmzygqzdqmrv@mail.mercadolivre.com",
				"DocType": "CPF",
				"DocNumber": "00000000",
				"Nickname": "TETE7160135",
				"Address": {
					"CountryId": "BR",
					"StateCode": "BR-SP",
					"State": "Sao Paulo",
					"City": "São Paulo",
					"Phone": "",
					"AlternativePhone": ""
				},
				"BillingInfo": {
					"DocType": "CPF",
					"DocNumber": "000000000"
				}
			},
			"Integrated": false,
			"IntegratedOrderId": "",
			"Invoice": {
				"DanfePdfUrl": "",
				"XmlUrl": ""
			},
			"Status": {
				"Key": 10,
				"Value": "A preparar"
			},
			"StatusType": {
				"Key": 1,
				"Value": "Pendiente"
			},
			"MarketPlace": {
				"Key": 1,
				"Value": "Mercado Livre"
			},
			"DateCreated": "2021-07-01T21:21:24Z",
			"LastUpdated": "2021-07-01T21:23:32Z",
			"DateClosed": "2021-07-01T21:21:26Z",
			"IsCancelled": false
		}
	]
}
GET orders example with a shopping cart:
{
   "Paging":{
      "Limit":100,
      "Offset":0,
      "Total":1
   },
   "AvailableSorts":[
      {
         "Id":"Id",
         "Name":"Order by internal ID asc"
      },
      {
         "Id":"dateCreated",
         "Name":"Order by date of sale asc"
      }
   ],
   "Total":2,
   "Results":[
      {
         "Id":784629,
         "SellerAccount":{
            "Id":11111111,
            "Name":"Razon social",
            "BusinessName":"Nombre de fantasía"
         },
         "ExternalOrderId":"2XX24XX652",
         "IntegratedOrderId":"",
         "PackId":"2000000730043114",
         "Items":[
            {
               "Id":615065,
               "Product":{
                  "Id":643442,
                  "Sku":"E101EAJ500",
                  "Brand":"Subaru",
                  "SellerSku":"XYZ",
                  "EAN":"",
                  "Title":"COBERTOR ABATIBLE PARACHOQUE TRASERO",
                  "IntegrationCode":"MLC5XX26XX22",
                  "Category":{
                     "Key":"MLC176992",
                     "Value":"Otros Cobertores"
                  }
               },
               "ProductListing":{
                  "Id":5097398,
                  "ExternalId":"MLA3X8409928",
                  "Title":"Super oferta COBERTOR ABATIBLE PARACHOQUE TRASERO",
                  "ListingType":{
                     "Key":7,
                     "Value":"free"
                  },
                  "PermanentLink":"https://articulo.mercadolibre.com.ar/MLA-83XXXXX/masinfo_JM"
               },			   
               "Quantity":1,
               "UnitPrice":XX094,
               "CalculatedComponentUnitPrice":0,
               "SaleFee":XX82,
               "Status":{
                  "Key":10,
                  "Value":"A Preparar"
               },
               "StatusType":{
                  "Key":1,
                  "Value":"Pendiente"
               },
               "UnitPriceCost":XXXX062,
               "Type":{
                  "Key":0,
                  "Value":"Product"
               },
               "IsCancelled":false
            }
         ],
         "Payments":[
            {
               "ExternalPaymentId":7XX7XX6760,
               "Amount":XX094,
               "AmountNoDiscount":XX094,
               "ShippingAmount":0,
               "ShippingAmountNoDiscount":0,
               "Installments":1,
               "Notes":"Cobertor Abatible Parachoque Trasero Subaru E101eaj500",
               "CurrencySymbol":"CLP",
               "Method":{
                  "Key":0,
                  "Value":"account_money"
               },
               "Status":{
                  "Key":1,
                  "Value":"approved - accredited"
               },
               "Taxes":{
                  
               },
               "DateCreated":"2020-07-31T17:46:56Z",
               "DateApproved":"2020-07-31T17:46:56Z",
               "LastUpdate":"2020-07-31T17:46:56Z"
            }
         ],
         "Shipping":{
            "ExternalShippingId":X0032XXX264,
            "Method":{
               "Key":3,
               "Value":"Mercado Envios"
            },
            "Status":{
               "Key":10,
               "Value":"ready_to_ship"
            },
            "LogisticType":{
               "Key":3,
               "Value":"me2"
            },
            "ShippingLabels":{
               "SubStatus":"ready_to_print",
               "ShippingLabelUrlPdf":"https://api.alephcrm.com/Pedidos/XYZ/MeliEtiqueta?IdCuenta=XYZ&formato=pdf&api_key=abcabcabc",
               "ShippingLabelUrlZip":"https://api.alephcrm.com/Pedidos/XYZ/MeliEtiqueta?IdCuenta=XYZ&formato=zpl2&api_key=abcabcabc"
            },
            "ReceiverAddress":{
               "City":"Rancagua",
               "State":"Libertador B. O'Higgins",
               "Neighborhood":"XXXX",
               "CountryId":"CL",
               "StreetName":"XXXX villalobos",
               "StreetNumber":"XXX",
               "Description":"XXXX villalobos XXXX, Rancagua - Libertador B. O'Higgins ()"
            },
            "Receiver":{
               "Name":"Luis XXXX",
               "Phone":"XYZYX"
            },
            "EstimatedDeliveryDate":"2020-09-17T04:00:00Z",
            "DateCreated":"2020-07-31T17:46:47Z",
            "LastUpdated":"2020-07-31T17:50:53Z"
         },
         "Buyer":{
            "Name":"Luis Gabriel XYZ",
            "Email":"lconsue.f8jqbr+2-ogi3damrugqztmojw@mail.mercadolibre.cl",
            "DocType":"RUT",
            "DocNumber":"23X82XX33",
            "Nickname":"CATADOR1989",
            "BillingInfo":{
               "DocType":"RUT",
               "DocNumber":"23X82XX33",
               "Address":{
                  "City":"XXX",
                  "State":"Libertador B. O'Higgins",
                  "Neighborhood":"Rancagua",
                  "CountryId":"CL",
                  "StreetName":"XXXX villalobos",
                  "StreetNumber":"1075",
                  "Notes":"XXXX",
                  "Description":"XXXX villalobos XXX, Rancagua - Libertador B. O'Higgins ()"
               }
            },
            "Address":{
               "City":"Rancagua",
               "State":"CL-LI",
               "CountryId":"CL",
               "Phone":"",
               "AlternativePhone":""
            }
         },
         "Integrated":true,
         "Status":{
            "Key":10,
            "Value":"A Preparar"
         },
         "StatusType":{
            "Key":1,
            "Value":"Pendiente"
         },
         "MarketPlace":{
            "Key":1,
            "Value":"Mercado Libre"
         },
         "DateCreated":"2020-07-31T17:46:47Z",
         "LastUpdated":"2020-07-31T17:46:57Z",
         "DateClosed":"2020-07-31T17:46:57Z",
         "IsCancelled":false
      },
      {
         "Id":785787,
         "SellerAccount":{
            "Id":11111111,
            "Name":"Razon social",
            "BusinessName":"Nombre de fantasía"
         },
         "ExternalOrderId":"2XX24XX652",
         "IntegratedOrderId":"",
         "PackId":"2000000730043114",
         "Items":[
            {
               "Id":615065,
               "Product":{
                  "Id":643442,
                  "Sku":"E101EAJ500",
                  "Brand":"Subaru",
                  "SellerSku":"XYZ",
                  "EAN":"",
                  "Title":"COBERTOR ABATIBLE PARACHOQUE TRASERO",
                  "IntegrationCode":"MLC5XX26XX22",
                  "Category":{
                     "Key":"MLC176992",
                     "Value":"Otros Cobertores"
                  }
               },
               "ProductListing":{
                  "Id":5097398,
                  "ExternalId":"MLA3X8409928",
                  "Title":"Super oferta COBERTOR ABATIBLE PARACHOQUE TRASERO",
                  "ListingType":{
                     "Key":7,
                     "Value":"free"
                  },
                  "PermanentLink":"https://articulo.mercadolibre.com.ar/MLA-83XXXXX/masinfo_JM"
               },				   
               "Quantity":1,
               "UnitPrice":XX094,
               "CalculatedComponentUnitPrice":0,
               "SaleFee":XX82,
               "Status":{
                  "Key":10,
                  "Value":"A Preparar"
               },
               "StatusType":{
                  "Key":1,
                  "Value":"Pendiente"
               },
               "UnitPriceCost":XXXX062,
               "Type":{
                  "Key":0,
                  "Value":"Product"
               },
               "IsCancelled":false
            }
         ],
         "Payments":[
            {
               "ExternalPaymentId":7XX7XX6760,
               "Amount":XX094,
               "AmountNoDiscount":XX094,
               "ShippingAmount":0,
               "ShippingAmountNoDiscount":0,
               "Installments":1,
               "Notes":"Cobertor Abatible Parachoque Trasero Subaru E101eaj500",
               "CurrencySymbol":"CLP",
               "Method":{
                  "Key":0,
                  "Value":"account_money"
               },
               "Status":{
                  "Key":1,
                  "Value":"approved - accredited"
               },
               "Taxes":{
                  
               },
               "DateCreated":"2020-07-31T17:46:56Z",
               "DateApproved":"2020-07-31T17:46:56Z",
               "LastUpdate":"2020-07-31T17:46:56Z"
            }
         ],
         "Shipping":{
            "ExternalShippingId":X0032XXX264,
            "Method":{
               "Key":3,
               "Value":"Mercado Envios"
            },
            "Status":{
               "Key":10,
               "Value":"ready_to_ship"
            },
            "LogisticType":{
               "Key":3,
               "Value":"me2"
            },
            "ShippingLabels":{
               "SubStatus":"ready_to_print",
               "ShippingLabelUrlPdf":"https://api.alephcrm.com/Pedidos/XYZ/MeliEtiqueta?IdCuenta=XYZ&formato=pdf&api_key=abcabcabc",
               "ShippingLabelUrlZip":"https://api.alephcrm.com/Pedidos/XYZ/MeliEtiqueta?IdCuenta=XYZ&formato=zpl2&api_key=abcabcabc"
            },
            "ReceiverAddress":{
               "City":"Rancagua",
               "State":"Libertador B. O'Higgins",
               "Neighborhood":"XXXX",
               "CountryId":"CL",
               "StreetName":"XXXX villalobos",
               "StreetNumber":"XXX",
               "Description":"XXXX villalobos XXXX, Rancagua - Libertador B. O'Higgins ()"
            },
            "Receiver":{
               "Name":"Luis XXXX",
               "Phone":"XYZYX"
            },
            "EstimatedDeliveryDate":"2020-09-17T04:00:00Z",
            "DateCreated":"2020-07-31T17:46:47Z",
            "LastUpdated":"2020-07-31T17:50:53Z"
         },
         "Buyer":{
            "Name":"Luis Gabriel XYZ",
            "Email":"lconsue.f8jqbr+2-ogi3damrugqztmojw@mail.mercadolibre.cl",
            "DocType":"RUT",
            "DocNumber":"23X82XX33",
            "Nickname":"CATADOR1989",
            "BillingInfo":{
               "DocType":"RUT",
               "DocNumber":"23X82XX33",
               "Address":{
                  "City":"XXX",
                  "State":"Libertador B. O'Higgins",
                  "Neighborhood":"Rancagua",
                  "CountryId":"CL",
                  "StreetName":"XXXX villalobos",
                  "StreetNumber":"1075",
                  "Notes":"XXXX",
                  "Description":"XXXX villalobos XXX, Rancagua - Libertador B. O'Higgins ()"
               }
            },
            "Address":{
               "City":"Rancagua",
               "State":"CL-LI",
               "CountryId":"CL",
               "Phone":"",
               "AlternativePhone":""
            }
         },
         "Integrated":true,
         "Status":{
            "Key":10,
            "Value":"A Preparar"
         },
         "StatusType":{
            "Key":1,
            "Value":"Pendiente"
         },
         "MarketPlace":{
            "Key":1,
            "Value":"Mercado Libre"
         },
         "DateCreated":"2020-07-31T17:46:47Z",
         "LastUpdated":"2020-07-31T17:46:57Z",
         "DateClosed":"2020-07-31T17:46:57Z",
         "IsCancelled":false
      }
   ]
}