# Melonn API

> Integrate your systems with Melonn's fulfillment platform.

REST API for Melonn sellers. Authenticate every request with your API key in the `x-api-key` header. Production: https://api.orbita.melonn.com. Sandbox: https://api.orbita-qa.melonn.com.

The complete contract, every endpoint, schema and webhook event, is in [openapi.yaml](https://developers.melonn.com/openapi.yaml). Every guide is also in [llms-full.txt](https://developers.melonn.com/llms-full.txt).

## Guides: Get started

- [Introduction](https://developers.melonn.com/introduction.md): Integrate your systems with Melonn's fulfillment platform.
- [Authentication](https://developers.melonn.com/authentication.md): Every request carries your API key in the x-api-key header.
- [Environments](https://developers.melonn.com/environments.md): Test in the sandbox, then switch to production.

## Guides: Reference data

- [Reference data](https://developers.melonn.com/catalogs.md): Codes you use when building requests: warehouses, shipping methods, VAS and official destinations.
- [Sell order states](https://developers.melonn.com/sell-order-states.md): The states a sell order goes through, and the promise and attempt objects returned with it.

## Guides: Webhooks

- [Webhooks](https://developers.melonn.com/webhooks/overview.md): Get notified at your own URL when something happens with your orders, returns or supplier orders.

## API reference: Sell orders

- [Sell orders](https://developers.melonn.com/api-reference/sell-orders-overview.md)
- [Add vas to order](https://developers.melonn.com/api-reference/sell-orders/add-vas-to-order): `POST /sell-orders/{external_order_number}/vas`
- [Add files to VAS](https://developers.melonn.com/api-reference/sell-orders/add-files-to-vas): `POST /sell-orders/{external_order_number}/vas/{vas_code}/files`
- [Get order list](https://developers.melonn.com/api-reference/sell-orders/get-order-list): `GET /sell-orders`
- [Create sell order](https://developers.melonn.com/api-reference/sell-orders/create-sell-order): `POST /sell-orders`
- [Get sell order](https://developers.melonn.com/api-reference/sell-orders/get-sell-order): `GET /sell-orders/{external_order_number}`
- [Get Delivery Documents](https://developers.melonn.com/api-reference/sell-orders/get-delivery-documents): `GET /sell-orders/{external_order_number}/delivery-documents`
- [Release hold fulfillment](https://developers.melonn.com/api-reference/sell-orders/release-hold-fulfillment): `POST /sell-orders/{external_order_number}/release-hold-fulfillment`
- [Request Cancelation](https://developers.melonn.com/api-reference/sell-orders/request-cancelation): `POST /sell-orders/{external_order_number}/request-cancellation`

## API reference: Business

- [Business](https://developers.melonn.com/api-reference/business-overview.md)
- [Get all](https://developers.melonn.com/api-reference/business/get-all): `GET /business`
- [Create in bulk](https://developers.melonn.com/api-reference/business/create-in-bulk): `POST /business`

## API reference: Seller products

- [Seller products](https://developers.melonn.com/api-reference/seller-products-overview.md)
- [Create Barcode](https://developers.melonn.com/api-reference/seller-products/create-barcode): `POST /seller-products/{sku}/barcode`
- [List Seller Product](https://developers.melonn.com/api-reference/seller-products/list-seller-product): `GET /seller-products`
- [Create Seller Product](https://developers.melonn.com/api-reference/seller-products/create-seller-product): `POST /seller-products`
- [Get Seller Product](https://developers.melonn.com/api-reference/seller-products/get-seller-product): `GET /seller-products/{sku}`
- [Update Seller Product](https://developers.melonn.com/api-reference/seller-products/update-seller-product): `PUT /seller-products/{sku}`

## API reference: Stock

- [Stock](https://developers.melonn.com/api-reference/stock-overview.md)
- [Get available stock](https://developers.melonn.com/api-reference/stock/get-available-stock): `GET /stock`
- [Get stock adjustments](https://developers.melonn.com/api-reference/stock/get-stock-adjustments): `GET /stock/adjustments`
- [Get inventory snapshot](https://developers.melonn.com/api-reference/stock/get-inventory-snapshot): `GET /stock/inventory`

## API reference: Supplier orders

- [Supplier orders](https://developers.melonn.com/api-reference/supplier-orders-overview.md)
- [Create supplier order](https://developers.melonn.com/api-reference/supplier-orders/create-supplier-order): `POST /supplier-orders`
- [List supplier orders](https://developers.melonn.com/api-reference/supplier-orders/list-supplier-orders): `GET /supplier-orders`
- [Get supplier order](https://developers.melonn.com/api-reference/supplier-orders/get-supplier-order): `GET /supplier-orders/{internal_order_number}`
- [Cancel supplier order](https://developers.melonn.com/api-reference/supplier-orders/cancel-supplier-order): `POST /supplier-orders/{internal_order_number}/cancel`
- [List seller suppliers](https://developers.melonn.com/api-reference/supplier-orders/list-seller-suppliers): `GET /seller-suppliers`
- [Create seller supplier](https://developers.melonn.com/api-reference/supplier-orders/create-seller-supplier): `POST /seller-suppliers`
- [Update seller supplier](https://developers.melonn.com/api-reference/supplier-orders/update-seller-supplier): `PUT /seller-suppliers/{id}`
- [Finalize supplier order](https://developers.melonn.com/api-reference/supplier-orders/finalize-supplier-order): `POST /supplier-orders/{internal_order_number}/finalize`

## API reference: Buyer return orders

- [Buyer return orders](https://developers.melonn.com/api-reference/buyer-return-orders-overview.md)
- [Create return order](https://developers.melonn.com/api-reference/buyer-return-orders--v2/create-return-order): `POST /buyer-return-orders/v2`
- [List return orders](https://developers.melonn.com/api-reference/buyer-return-orders--v2/list-return-orders): `GET /buyer-return-orders/v2`
- [Get return order](https://developers.melonn.com/api-reference/buyer-return-orders--v2/get-return-order): `GET /buyer-return-orders/v2/{id}`
- [Cancel return order](https://developers.melonn.com/api-reference/buyer-return-orders--v2/cancel-return-order): `POST /buyer-return-orders/v2/{internal_order_number}/cancel`

## API reference: Sell order issues

- [Sell order issues](https://developers.melonn.com/api-reference/sell-order-issues-overview.md)
- [List sell order issues](https://developers.melonn.com/api-reference/sell-order-issues/list-sell-order-issues): `GET /sell-order-issues`
- [Get sell order issue](https://developers.melonn.com/api-reference/sell-order-issues/get-sell-order-issue): `GET /sell-order-issues/{issueCode}`

## API reference: Courier companies

- [Get all](https://developers.melonn.com/api-reference/courier-companies/get-all): `GET /courier-companies`

## API reference: Sell order events

- [Sell order received](https://developers.melonn.com/api-reference/sell-order-events/sell-order-received): `webhook SELL_ORDER/RECEIVED_VALID`
- [Sell order items reserved](https://developers.melonn.com/api-reference/sell-order-events/sell-order-items-reserved): `webhook SELL_ORDER/ITEMS_RESERVED`
- [Sell order packed](https://developers.melonn.com/api-reference/sell-order-events/sell-order-packed): `webhook SELL_ORDER/PACKED`
- [Sell order shipped](https://developers.melonn.com/api-reference/sell-order-events/sell-order-shipped): `webhook SELL_ORDER/SHIPPED`
- [Sell order delivered](https://developers.melonn.com/api-reference/sell-order-events/sell-order-delivered): `webhook SELL_ORDER/DELIVERED_TO_BUYER`
- [Sell order picked up](https://developers.melonn.com/api-reference/sell-order-events/sell-order-picked-up): `webhook SELL_ORDER/PICKED_UP_BY_BUYER`
- [Sell order canceled](https://developers.melonn.com/api-reference/sell-order-events/sell-order-canceled): `webhook SELL_ORDER/CANCELED`
- [Sell order fully shipped](https://developers.melonn.com/api-reference/sell-order-events/sell-order-fully-shipped): `webhook SELL_ORDER/ALL_PACKAGES_SHIPPED`
- [Sell order picking started](https://developers.melonn.com/api-reference/sell-order-events/sell-order-picking-started): `webhook SELL_ORDER/PICKING_STARTED`
- [Sell order packing started](https://developers.melonn.com/api-reference/sell-order-events/sell-order-packing-started): `webhook SELL_ORDER/PACKING_STARTED`
- [Sell order missing item reported](https://developers.melonn.com/api-reference/sell-order-events/sell-order-missing-item-reported): `webhook SELL_ORDER/MISSING_ITEM_REPORTED`
- [Sell order missing bin reported](https://developers.melonn.com/api-reference/sell-order-events/sell-order-missing-bin-reported): `webhook SELL_ORDER/MISSING_BIN_REPORTED`
- [Picking group missing item reported](https://developers.melonn.com/api-reference/sell-order-events/picking-group-missing-item-reported): `webhook SELL_ORDER_PICKING_GROUP/MISSING_ITEM_REPORTED_BY_SELLER`

## API reference: Stock events

- [Stock control point executed](https://developers.melonn.com/api-reference/stock-events/stock-control-point-executed): `webhook STOCK_MGMT/STOCK_CONTROL_POINT_EXECUTED`
- [Missing stock items reported](https://developers.melonn.com/api-reference/stock-events/missing-stock-items-reported): `webhook STOCK_MGMT/MISSING_ITEMS_BY_SELLER`
- [Stock items reconciled](https://developers.melonn.com/api-reference/stock-events/stock-items-reconciled): `webhook STOCK_MGMT/RECONCILED_ITEMS_BY_SELLER`
- [Unfulfillable units reported](https://developers.melonn.com/api-reference/stock-events/unfulfillable-units-reported): `webhook STOCK_MGMT/UNFULFILLABLE_REPORTED`
- [Unfulfillable units transferred](https://developers.melonn.com/api-reference/stock-events/unfulfillable-units-transferred): `webhook STOCK_MGMT/UNFULFILLABLE_EXECUTED`
- [Unfulfillable units released](https://developers.melonn.com/api-reference/stock-events/unfulfillable-units-released): `webhook STOCK_MGMT/UNFULFILLABLE_RELEASED`

## API reference: Return order events

- [Return order created](https://developers.melonn.com/api-reference/return-order-events/return-order-created): `webhook BUYER_RETURN_ORDER/CREATED`
- [Return label generated](https://developers.melonn.com/api-reference/return-order-events/return-label-generated): `webhook BUYER_RETURN_ORDER/ITSR_LABEL_GENERATED`
- [Return received at warehouse](https://developers.melonn.com/api-reference/return-order-events/return-received-at-warehouse): `webhook BUYER_RETURN_ORDER/RECEIVED_AT_WAREHOUSE`
- [Return unpacked](https://developers.melonn.com/api-reference/return-order-events/return-unpacked): `webhook BUYER_RETURN_ORDER/UNPACKED`
- [Return order canceled](https://developers.melonn.com/api-reference/return-order-events/return-order-canceled): `webhook BUYER_RETURN_ORDER/CANCELED`

## API reference: Supplier order events

- [Supplier order created](https://developers.melonn.com/api-reference/supplier-order-events/supplier-order-created): `webhook SUPPLIER_ORDER/CREATED`
- [Supplier order canceled](https://developers.melonn.com/api-reference/supplier-order-events/supplier-order-canceled): `webhook SUPPLIER_ORDER/CANCELLED`
- [Supplier order closed](https://developers.melonn.com/api-reference/supplier-order-events/supplier-order-closed): `webhook SUPPLIER_ORDER/CLOSED`
- [Supplier order package unpacked](https://developers.melonn.com/api-reference/supplier-order-events/supplier-order-package-unpacked): `webhook SUPPLIER_ORDER_PACKAGE/UNPACKED`

## Changelog

- [Changelog](https://developers.melonn.com/changelog.md): Changes to the Melonn API, newest first.