Omnyfy
Powered by Redocly

Order Management

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 Click and Collect Order Status

This endpoint only available when the marketplace has Omnyfy Click and Collect module enabled. Get the Click and Collect Status of an order. Required for processing click and collect orders

Request
Request Body schema: application/json
optional
required
object (omnyfy-click-collect-data-order-interface)
Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/rest/V1/omnyfy-clickcollect/clickcollect
Request samples
application/json
{
  • "order": {
    }
}
Response samples
application/json
{
  • "message": "string",
  • "errors": [
    ],
  • "code": 0,
  • "parameters": [
    ],
  • "trace": "string"
}
➔ Next to Shipment