Omnyfy
Powered by Redocly

Vendor endpoints

Delete product

delete product

Request
path Parameters
sku
required
string
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

delete/rest/V1/products/{sku}
Response samples
application/json
true

Import products

This API provides aggregated product import with better performance than the stock Magento V1/products API. Import product, image upload, assign vendor and set vendor location quantity can be done within one API call.

  1. Please use the field “variant_skus” to provide all child product SKUs for the configurable (parent) product.
  2. Please use the field “super_attribute_codes” to provide all attributes (example, colour, size etc) that are used to link child product SKUs to the configurable (parent) product.
  3. Please provide values in each child product for attributes in parent product in point 2 above where 4763 is the code for the colour of that child product. Example - { "attribute_code": "color", "value": 4763 }
  4. Please use the field “type_id”. Value will be “configurable” for parent product and “simple” for child products.
  5. Please use the field “visibility”.Value will be 4 for parent product and 1 for child products.
  6. See Response samples - items from above points are provided. You do not need to send the child products in the same payload
Request
Request Body schema: application/json
optional
required
Array of objects (omnyfy-product-import)
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

post/V1/omnyfy/products
Request samples
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Response samples
application/json
{
  • "items": [
    ]
}

Get inventory for a specific vendor

Get inventory for a specific vendor

Example - Get inventory for sku value equals to 'example-sku'
curl --location --globoff 'https://your-marketplace-host/rest/V1/inventory/source-items?searchCriteria[filterGroups][0][filters][0][conditionType]=eq&searchCriteria[currentPage]=1&searchCriteria[pageSize]=10&searchCriteria[filterGroups][0][filters][0][field]=sku&searchCriteria[filterGroups][0][filters][0][value]={example-sku}'
Request
query Parameters
searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[sortOrders][0][field]
string

Sorting field.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[pageSize]
integer

Page size.

searchCriteria[currentPage]
integer

Current page.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/inventory/source-items
Response samples
application/json
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

get vendor integration token

Create integration token for admin given the vendor credentials.

Request
Request Body schema: application/json
required
username
required
string
password
required
string
Responses
200

200 Success.

400

400 Bad Request

default

Unexpected error

post/rest/V1/integration/vendor/token
Request samples
application/json
{
  • "username": "string",
  • "password": "string"
}
Response samples
application/json
{
  • "token": "string"
}

Get Order

Loads a specified order.

Request
path Parameters
id
required
integer

The order ID.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/orders/{id}
Response samples
{
  • "adjustment_negative": 0,
  • "adjustment_positive": 0,
  • "applied_rule_ids": "string",
  • "base_adjustment_negative": 0,
  • "base_adjustment_positive": 0,
  • "base_currency_code": "string",
  • "base_discount_amount": 0,
  • "base_discount_canceled": 0,
  • "base_discount_invoiced": 0,
  • "base_discount_refunded": 0,
  • "base_grand_total": 0,
  • "base_discount_tax_compensation_amount": 0,
  • "base_discount_tax_compensation_invoiced": 0,
  • "base_discount_tax_compensation_refunded": 0,
  • "base_shipping_amount": 0,
  • "base_shipping_canceled": 0,
  • "base_shipping_discount_amount": 0,
  • "base_shipping_discount_tax_compensation_amnt": 0,
  • "base_shipping_incl_tax": 0,
  • "base_shipping_invoiced": 0,
  • "base_shipping_refunded": 0,
  • "base_shipping_tax_amount": 0,
  • "base_shipping_tax_refunded": 0,
  • "base_subtotal": 0,
  • "base_subtotal_canceled": 0,
  • "base_subtotal_incl_tax": 0,
  • "base_subtotal_invoiced": 0,
  • "base_subtotal_refunded": 0,
  • "base_tax_amount": 0,
  • "base_tax_canceled": 0,
  • "base_tax_invoiced": 0,
  • "base_tax_refunded": 0,
  • "base_total_canceled": 0,
  • "base_total_due": 0,
  • "base_total_invoiced": 0,
  • "base_total_invoiced_cost": 0,
  • "base_total_offline_refunded": 0,
  • "base_total_online_refunded": 0,
  • "base_total_paid": 0,
  • "base_total_qty_ordered": 0,
  • "base_total_refunded": 0,
  • "base_to_global_rate": 0,
  • "base_to_order_rate": 0,
  • "billing_address_id": 0,
  • "can_ship_partially": 0,
  • "can_ship_partially_item": 0,
  • "coupon_code": "string",
  • "created_at": "string",
  • "customer_dob": "string",
  • "customer_email": "string",
  • "customer_firstname": "string",
  • "customer_gender": 0,
  • "customer_group_id": 0,
  • "customer_id": 0,
  • "customer_is_guest": 0,
  • "customer_lastname": "string",
  • "customer_middlename": "string",
  • "customer_note": "string",
  • "customer_note_notify": 0,
  • "customer_prefix": "string",
  • "customer_suffix": "string",
  • "customer_taxvat": "string",
  • "discount_amount": 0,
  • "discount_canceled": 0,
  • "discount_description": "string",
  • "discount_invoiced": 0,
  • "discount_refunded": 0,
  • "edit_increment": 0,
  • "email_sent": 0,
  • "entity_id": 0,
  • "ext_customer_id": "string",
  • "ext_order_id": "string",
  • "forced_shipment_with_invoice": 0,
  • "global_currency_code": "string",
  • "grand_total": 0,
  • "discount_tax_compensation_amount": 0,
  • "discount_tax_compensation_invoiced": 0,
  • "discount_tax_compensation_refunded": 0,
  • "hold_before_state": "string",
  • "hold_before_status": "string",
  • "increment_id": "string",
  • "is_virtual": 0,
  • "order_currency_code": "string",
  • "original_increment_id": "string",
  • "payment": {
    },
  • "payment_authorization_amount": 0,
  • "payment_auth_expiration": 0,
  • "protect_code": "string",
  • "quote_address_id": 0,
  • "quote_id": 0,
  • "relation_child_id": "string",
  • "relation_child_real_id": "string",
  • "relation_parent_id": "string",
  • "relation_parent_real_id": "string",
  • "remote_ip": "string",
  • "shipping_amount": 0,
  • "shipping_canceled": 0,
  • "shipping_description": "string",
  • "shipping_discount_amount": 0,
  • "shipping_discount_tax_compensation_amount": 0,
  • "shipping_incl_tax": 0,
  • "shipping_invoiced": 0,
  • "shipping_refunded": 0,
  • "shipping_tax_amount": 0,
  • "shipping_tax_refunded": 0,
  • "state": "string",
  • "status": "string",
  • "store_currency_code": "string",
  • "store_id": 0,
  • "store_name": "string",
  • "store_to_base_rate": 0,
  • "store_to_order_rate": 0,
  • "subtotal": 0,
  • "subtotal_canceled": 0,
  • "subtotal_incl_tax": 0,
  • "subtotal_invoiced": 0,
  • "subtotal_refunded": 0,
  • "tax_amount": 0,
  • "tax_canceled": 0,
  • "tax_invoiced": 0,
  • "tax_refunded": 0,
  • "total_canceled": 0,
  • "total_due": 0,
  • "total_invoiced": 0,
  • "total_item_count": 0,
  • "total_offline_refunded": 0,
  • "total_online_refunded": 0,
  • "total_paid": 0,
  • "total_qty_ordered": 0,
  • "total_refunded": 0,
  • "updated_at": "string",
  • "weight": 0,
  • "x_forwarded_for": "string",
  • "items": [
    ],
  • "billing_address": {
    },
  • "extension_attributes": {
    }
}

Get Orders List

Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See

Request
query Parameters
searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[sortOrders][0][field]
string

Sorting field.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[pageSize]
integer

Page size.

searchCriteria[currentPage]
integer

Current page.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/orders
Response samples
application/json
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

Create Order

Native API call to create an order.

Request
Request Body schema:
required
required
object (sales-data-order-interface)

Order interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/rest/V1/orders
Request samples
{
  • "entity": {
    }
}
Response samples
{
  • "adjustment_negative": 0,
  • "adjustment_positive": 0,
  • "applied_rule_ids": "string",
  • "base_adjustment_negative": 0,
  • "base_adjustment_positive": 0,
  • "base_currency_code": "string",
  • "base_discount_amount": 0,
  • "base_discount_canceled": 0,
  • "base_discount_invoiced": 0,
  • "base_discount_refunded": 0,
  • "base_grand_total": 0,
  • "base_discount_tax_compensation_amount": 0,
  • "base_discount_tax_compensation_invoiced": 0,
  • "base_discount_tax_compensation_refunded": 0,
  • "base_shipping_amount": 0,
  • "base_shipping_canceled": 0,
  • "base_shipping_discount_amount": 0,
  • "base_shipping_discount_tax_compensation_amnt": 0,
  • "base_shipping_incl_tax": 0,
  • "base_shipping_invoiced": 0,
  • "base_shipping_refunded": 0,
  • "base_shipping_tax_amount": 0,
  • "base_shipping_tax_refunded": 0,
  • "base_subtotal": 0,
  • "base_subtotal_canceled": 0,
  • "base_subtotal_incl_tax": 0,
  • "base_subtotal_invoiced": 0,
  • "base_subtotal_refunded": 0,
  • "base_tax_amount": 0,
  • "base_tax_canceled": 0,
  • "base_tax_invoiced": 0,
  • "base_tax_refunded": 0,
  • "base_total_canceled": 0,
  • "base_total_due": 0,
  • "base_total_invoiced": 0,
  • "base_total_invoiced_cost": 0,
  • "base_total_offline_refunded": 0,
  • "base_total_online_refunded": 0,
  • "base_total_paid": 0,
  • "base_total_qty_ordered": 0,
  • "base_total_refunded": 0,
  • "base_to_global_rate": 0,
  • "base_to_order_rate": 0,
  • "billing_address_id": 0,
  • "can_ship_partially": 0,
  • "can_ship_partially_item": 0,
  • "coupon_code": "string",
  • "created_at": "string",
  • "customer_dob": "string",
  • "customer_email": "string",
  • "customer_firstname": "string",
  • "customer_gender": 0,
  • "customer_group_id": 0,
  • "customer_id": 0,
  • "customer_is_guest": 0,
  • "customer_lastname": "string",
  • "customer_middlename": "string",
  • "customer_note": "string",
  • "customer_note_notify": 0,
  • "customer_prefix": "string",
  • "customer_suffix": "string",
  • "customer_taxvat": "string",
  • "discount_amount": 0,
  • "discount_canceled": 0,
  • "discount_description": "string",
  • "discount_invoiced": 0,
  • "discount_refunded": 0,
  • "edit_increment": 0,
  • "email_sent": 0,
  • "entity_id": 0,
  • "ext_customer_id": "string",
  • "ext_order_id": "string",
  • "forced_shipment_with_invoice": 0,
  • "global_currency_code": "string",
  • "grand_total": 0,
  • "discount_tax_compensation_amount": 0,
  • "discount_tax_compensation_invoiced": 0,
  • "discount_tax_compensation_refunded": 0,
  • "hold_before_state": "string",
  • "hold_before_status": "string",
  • "increment_id": "string",
  • "is_virtual": 0,
  • "order_currency_code": "string",
  • "original_increment_id": "string",
  • "payment": {
    },
  • "payment_authorization_amount": 0,
  • "payment_auth_expiration": 0,
  • "protect_code": "string",
  • "quote_address_id": 0,
  • "quote_id": 0,
  • "relation_child_id": "string",
  • "relation_child_real_id": "string",
  • "relation_parent_id": "string",
  • "relation_parent_real_id": "string",
  • "remote_ip": "string",
  • "shipping_amount": 0,
  • "shipping_canceled": 0,
  • "shipping_description": "string",
  • "shipping_discount_amount": 0,
  • "shipping_discount_tax_compensation_amount": 0,
  • "shipping_incl_tax": 0,
  • "shipping_invoiced": 0,
  • "shipping_refunded": 0,
  • "shipping_tax_amount": 0,
  • "shipping_tax_refunded": 0,
  • "state": "string",
  • "status": "string",
  • "store_currency_code": "string",
  • "store_id": 0,
  • "store_name": "string",
  • "store_to_base_rate": 0,
  • "store_to_order_rate": 0,
  • "subtotal": 0,
  • "subtotal_canceled": 0,
  • "subtotal_incl_tax": 0,
  • "subtotal_invoiced": 0,
  • "subtotal_refunded": 0,
  • "tax_amount": 0,
  • "tax_canceled": 0,
  • "tax_invoiced": 0,
  • "tax_refunded": 0,
  • "total_canceled": 0,
  • "total_due": 0,
  • "total_invoiced": 0,
  • "total_item_count": 0,
  • "total_offline_refunded": 0,
  • "total_online_refunded": 0,
  • "total_paid": 0,
  • "total_qty_ordered": 0,
  • "total_refunded": 0,
  • "updated_at": "string",
  • "weight": 0,
  • "x_forwarded_for": "string",
  • "items": [
    ],
  • "billing_address": {
    },
  • "extension_attributes": {
    }
}

Get Order Items

Get a list of items ordered on the marketplace by Vendor.

Request
query Parameters
searchCriteria[pageSize]
required
integer
searchCriteria[currentPage]
required
integer

setup current page for pagination

searchCriteria[filterGroups][0][filters][0][field]
string

specified filter key, for example "vendor_id"

searchCriteria[filterGroups][0][filters][0][value]
string

specified filter value, for example "4"

searchCriteria[filterGroups][0][filters][0][conditionType]
string

specified filter condition type, for example "eq"

Responses
200

200 Success.

get/rest/V1/orders/items

Get Shipment

Loads a specified shipment.

Request
path Parameters
id
required
integer

The shipment ID.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/shipment/{id}
Response samples
{
  • "billing_address_id": 0,
  • "created_at": "string",
  • "customer_id": 0,
  • "email_sent": 0,
  • "entity_id": 0,
  • "increment_id": "string",
  • "order_id": 0,
  • "packages": [
    ],
  • "shipment_status": 0,
  • "shipping_address_id": 0,
  • "shipping_label": "string",
  • "store_id": 0,
  • "total_qty": 0,
  • "total_weight": 0,
  • "updated_at": "string",
  • "items": [
    ],
  • "tracks": [
    ],
  • "comments": [
    ],
  • "extension_attributes": {
    }
}

Get Shipments

Lists shipments that match specified search criteria. This call returns an array of objects

Request
query Parameters
searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[sortOrders][0][field]
string

Sorting field.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[pageSize]
integer

Page size.

searchCriteria[currentPage]
integer

Current page.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/shipments
Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

Create Shipment

Native API call to create an shipment.

Request
Request Body schema:
required
required
object (sales-data-shipment-interface)

Shipment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/rest/V1/shipment
Request samples
{
  • "entity": {
    }
}
Response samples
{
  • "billing_address_id": 0,
  • "created_at": "string",
  • "customer_id": 0,
  • "email_sent": 0,
  • "entity_id": 0,
  • "increment_id": "string",
  • "order_id": 0,
  • "packages": [
    ],
  • "shipment_status": 0,
  • "shipping_address_id": 0,
  • "shipping_label": "string",
  • "store_id": 0,
  • "total_qty": 0,
  • "total_weight": 0,
  • "updated_at": "string",
  • "items": [
    ],
  • "tracks": [
    ],
  • "comments": [
    ],
  • "extension_attributes": {
    }
}