curl --request GET \
--url https://api.orbita.melonn.com/supplier-orders/{internal_order_number} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.orbita.melonn.com/supplier-orders/{internal_order_number}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.orbita.melonn.com/supplier-orders/{internal_order_number}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbita.melonn.com/supplier-orders/{internal_order_number}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.orbita.melonn.com/supplier-orders/{internal_order_number}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.orbita.melonn.com/supplier-orders/{internal_order_number}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbita.melonn.com/supplier-orders/{internal_order_number}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 12345,
"seller_supplier_id": 123,
"destination_warehouse_code": "WCOD-1",
"internal_order_number": "I00012345",
"external_order_number": "PO-2025-001",
"creation_date": "2025-01-15T10:30:00.000Z",
"supplier_order_state": {
"code": 5,
"description": "Finalized",
"closed": true
},
"comments": "Urgent replenishment order",
"supplier_order_lines": [
{
"sku": "PROD-ABC-001",
"original": true,
"qty_ordered": 100,
"qty_received_ok": 98,
"qty_received_defective": 2,
"expiration_date": "2026-12-31T00:00:00.000Z",
"lot_number": "LOT-2025-001",
"reception_services": [
{
"reception_service_code": "lab",
"requested_by_seller": true,
"qty_executed": 98
}
]
},
{
"sku": "PROD-XYZ-002",
"original": true,
"qty_ordered": 50,
"qty_received_ok": 50,
"qty_received_defective": 0,
"expiration_date": null,
"lot_number": null,
"reception_services": [
{
"reception_service_code": "lab",
"requested_by_seller": true,
"qty_executed": 50
},
{
"reception_service_code": "bag",
"requested_by_seller": true,
"qty_executed": 50
}
]
}
],
"supplier_order_packages": [
{
"internal_package_number": "B00012345001",
"reception_date": "2025-01-20T14:00:00.000Z",
"max_unpack_promise": "2025-01-22T23:59:59.000Z",
"unpacking_end_date": "2025-01-21T09:30:00.000Z"
},
{
"internal_package_number": "B00012345002",
"reception_date": "2025-01-20T14:00:00.000Z",
"max_unpack_promise": "2025-01-22T23:59:59.000Z",
"unpacking_end_date": null
}
],
"attachments": [
{
"type": "DOCUMENT",
"url": "https://example-bucket.s3.amazonaws.com/invoice.pdf?X-Amz-Signature=...",
"creation_date": "2025-01-20T15:10:00.000Z"
},
{
"type": "RECEPTION_PHOTO",
"url": "https://example-bucket.s3.amazonaws.com/reception-1.jpg?X-Amz-Signature=..."
},
{
"type": "RECEPTION_LABEL_PHOTO",
"url": "https://example-bucket.s3.amazonaws.com/label-1.jpg?X-Amz-Signature=..."
}
]
}{
"statusCode": 403,
"errorCode": "SUPPLIER_ORDER_NOT_FOUND",
"message": "SUPPLIER_ORDER_NOT_FOUND"
}Get supplier order
Returns one of your supplier orders with its line items, packages and attachments.
supplier_order_linesare the order’s line items.original: falsemarks a line added during reception (a product that arrived but was not in the order).supplier_order_packagesare the packages received for the order. Packages removed by the warehouse are not listed.attachmentsare the order’s documents and the photos taken when each shipment was received, each with a downloadurl. Signed URLs expire 1 hour after the response; request the order again to get fresh ones.
Supplier order states
| Code | Name | Closed |
|---|---|---|
| 1 | Created | No |
| 2 | Confirmed | No |
| 3 | Canceled | Yes |
| 4 | Reception in process | No |
| 5 | Finalized | Yes |
| 6 | Unpacking in progress | No |
| 7 | Unpacked with differences | No |
Deprecated return address fields
The return_* fields are not part of the response: they are never returned, for any
order.
curl --request GET \
--url https://api.orbita.melonn.com/supplier-orders/{internal_order_number} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.orbita.melonn.com/supplier-orders/{internal_order_number}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.orbita.melonn.com/supplier-orders/{internal_order_number}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbita.melonn.com/supplier-orders/{internal_order_number}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.orbita.melonn.com/supplier-orders/{internal_order_number}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.orbita.melonn.com/supplier-orders/{internal_order_number}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbita.melonn.com/supplier-orders/{internal_order_number}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 12345,
"seller_supplier_id": 123,
"destination_warehouse_code": "WCOD-1",
"internal_order_number": "I00012345",
"external_order_number": "PO-2025-001",
"creation_date": "2025-01-15T10:30:00.000Z",
"supplier_order_state": {
"code": 5,
"description": "Finalized",
"closed": true
},
"comments": "Urgent replenishment order",
"supplier_order_lines": [
{
"sku": "PROD-ABC-001",
"original": true,
"qty_ordered": 100,
"qty_received_ok": 98,
"qty_received_defective": 2,
"expiration_date": "2026-12-31T00:00:00.000Z",
"lot_number": "LOT-2025-001",
"reception_services": [
{
"reception_service_code": "lab",
"requested_by_seller": true,
"qty_executed": 98
}
]
},
{
"sku": "PROD-XYZ-002",
"original": true,
"qty_ordered": 50,
"qty_received_ok": 50,
"qty_received_defective": 0,
"expiration_date": null,
"lot_number": null,
"reception_services": [
{
"reception_service_code": "lab",
"requested_by_seller": true,
"qty_executed": 50
},
{
"reception_service_code": "bag",
"requested_by_seller": true,
"qty_executed": 50
}
]
}
],
"supplier_order_packages": [
{
"internal_package_number": "B00012345001",
"reception_date": "2025-01-20T14:00:00.000Z",
"max_unpack_promise": "2025-01-22T23:59:59.000Z",
"unpacking_end_date": "2025-01-21T09:30:00.000Z"
},
{
"internal_package_number": "B00012345002",
"reception_date": "2025-01-20T14:00:00.000Z",
"max_unpack_promise": "2025-01-22T23:59:59.000Z",
"unpacking_end_date": null
}
],
"attachments": [
{
"type": "DOCUMENT",
"url": "https://example-bucket.s3.amazonaws.com/invoice.pdf?X-Amz-Signature=...",
"creation_date": "2025-01-20T15:10:00.000Z"
},
{
"type": "RECEPTION_PHOTO",
"url": "https://example-bucket.s3.amazonaws.com/reception-1.jpg?X-Amz-Signature=..."
},
{
"type": "RECEPTION_LABEL_PHOTO",
"url": "https://example-bucket.s3.amazonaws.com/label-1.jpg?X-Amz-Signature=..."
}
]
}{
"statusCode": 403,
"errorCode": "SUPPLIER_ORDER_NOT_FOUND",
"message": "SUPPLIER_ORDER_NOT_FOUND"
}Authorizations
Path Parameters
Internal order number assigned by Melonn (e.g. I00012345).
Response
The supplier order.
A supplier order with its line items, packages and attachments.
Melonn id of the supplier order.
Melonn id of the supplier.
Code of the destination warehouse.
Internal order number assigned by Melonn. Use it in the other supplier order endpoints.
Your identifier for the order. Absent when the order has none.
Date and time the order was created.
Current state of the supplier order.
Show child attributes
Show child attributes
Comments of the order. Absent when the order has none.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes