Omnyfy
Powered by Redocly

Sales

creating customer, create order for customer

Save quote for customer

Enable an customer or guest user to create an empty cart and quote for an anonymous customer.

Responses
200

200 Success.

400

400 Bad Request

default

Unexpected error

post/rest/V1/guest-carts
Response samples
"string"

Get quote

Returns information for the cart for a specified customer.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

get/rest/V1/carts/mine
Response samples
{
  • "id": 0,
  • "created_at": "string",
  • "updated_at": "string",
  • "converted_at": "string",
  • "is_active": true,
  • "is_virtual": true,
  • "items": [
    ],
  • "items_count": 0,
  • "items_qty": 0,
  • "customer": {
    },
  • "billing_address": {
    },
  • "reserved_order_id": "string",
  • "orig_order_id": 0,
  • "currency": {
    },
  • "customer_is_guest": true,
  • "customer_note": "string",
  • "customer_note_notify": true,
  • "customer_tax_class_id": 0,
  • "store_id": 0,
  • "extension_attributes": {
    }
}

Save quote for customer

Save quote

Request
Request Body schema: application/json
optional
required
object (quote-data-cart-interface)

Interface CartInterface

Responses
401

401 Unauthorized

default

Unexpected error

put/rest/V1/carts/mine
Request samples
application/json
{
  • "quote": {
    }
}
Response samples
application/json
{
  • "message": "string",
  • "errors": [
    ],
  • "code": 0,
  • "parameters": [
    ],
  • "trace": "string"
}

Create quote

Creates an empty cart and quote for a specified customer if customer does not have a cart yet.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

post/rest/V1/carts/mine
Response samples
application/json
0
0

Creates an empty cart and quote for a guest.

Creates an empty cart and quote for a guest.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

post/rest/V1/carts
Response samples
0
0

Lists cart items

Lists items that are assigned to a specified cart.

Request
path Parameters
cartId
required
integer

The cart ID.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

get/rest/V1/carts/{cartId}/items
Response samples
[
  • {
    }
]

Add/update the specified cart item.

Add/update the specified cart item.

Request
path Parameters
cartId
required
string
itemId
required
string
Request Body schema:
optional
required
object (quote-data-cart-item-interface)

Interface CartItemInterface

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

put/rest/V1/carts/{cartId}/items/{itemId}
Request samples
{
  • "cartItem": {
    }
}
Response samples
{
  • "item_id": 0,
  • "sku": "string",
  • "qty": 0,
  • "name": "string",
  • "price": 0,
  • "product_type": "string",
  • "quote_id": "string",
  • "product_option": { }
}

Removes the specified item from the specified cart.

Removes the specified item from the specified cart.

Request
path Parameters
cartId
required
integer

The cart ID.

itemId
required
integer

The item ID of the item to be removed.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

delete/rest/V1/carts/{cartId}/items/{itemId}
Response samples
true

Lists items that are assigned to a specified cart.

Lists items that are assigned to a specified cart.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

get/rest/V1/carts/mine/items
Response samples
[
  • {
    }
]

Add/update the specified cart item.

Add/update the specified cart item.

Request
Request Body schema:
optional
required
object (quote-data-cart-item-interface)

Interface CartItemInterface

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

post/rest/V1/carts/mine/items
Request samples
{
  • "cartItem": {
    }
}
Response samples
{
  • "item_id": 0,
  • "sku": "string",
  • "qty": 0,
  • "name": "string",
  • "price": 0,
  • "product_type": "string",
  • "quote_id": "string",
  • "product_option": { }
}

Add/update the specified cart item.

Add/update the specified cart item.

Request
path Parameters
itemId
required
string
Request Body schema:
optional
required
object (quote-data-cart-item-interface)

Interface CartItemInterface

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

put/rest/V1/carts/mine/items/{itemId}
Request samples
{
  • "cartItem": {
    }
}
Response samples
{
  • "item_id": 0,
  • "sku": "string",
  • "qty": 0,
  • "name": "string",
  • "price": 0,
  • "product_type": "string",
  • "quote_id": "string",
  • "product_option": { }
}

Removes the specified item from the specified cart.

Removes the specified item from the specified cart.

Request
path Parameters
itemId
required
integer

The item ID of the item to be removed.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

delete/rest/V1/carts/mine/items/{itemId}
Response samples
true

List items that are assigned to a specified cart.

List items that are assigned to a specified cart.

Request
path Parameters
cartId
required
string

The cart ID.

Responses
200

200 Success.

400

400 Bad Request

default

Unexpected error

get/rest/V1/guest-carts/{cartId}/items
Response samples
[
  • {
    }
]

Add/update the specified cart item.

Add/update the specified cart item.

Request
path Parameters
cartId
required
string
Request Body schema:
optional
required
object (quote-data-cart-item-interface)

Interface CartItemInterface

Responses
200

200 Success.

400

400 Bad Request

default

Unexpected error

post/rest/V1/guest-carts/{cartId}/items
Request samples
{
  • "cartItem": {
    }
}
Response samples
{
  • "item_id": 0,
  • "sku": "string",
  • "qty": 0,
  • "name": "string",
  • "price": 0,
  • "product_type": "string",
  • "quote_id": "string",
  • "product_option": { }
}

Add/update the specified cart item.

Add/update the specified cart item.

Request
path Parameters
cartId
required
string
itemId
required
string
Request Body schema:
optional
required
object (quote-data-cart-item-interface)

Interface CartItemInterface

Responses
200

200 Success.

400

400 Bad Request

default

Unexpected error

put/rest/V1/guest-carts/{cartId}/items/{itemId}
Request samples
{
  • "cartItem": {
    }
}
Response samples
{
  • "item_id": 0,
  • "sku": "string",
  • "qty": 0,
  • "name": "string",
  • "price": 0,
  • "product_type": "string",
  • "quote_id": "string",
  • "product_option": { }
}

Remove the specified item from the specified cart

Remove the specified item from the specified cart.

Request
path Parameters
cartId
required
string

The cart ID.

itemId
required
integer

The item ID of the item to be removed.

Responses
200

200 Success.

400

400 Bad Request

default

Unexpected error

delete/rest/V1/guest-carts/{cartId}/items/{itemId}
Response samples
true

set customer shipping address and billing address

set customer shipping address and billing address

Request
Request Body schema:
optional
required
object (checkout-data-shipping-information-interface)

Interface ShippingInformationInterface

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/rest/V1/carts/mine/shipping-information
Request samples
{
  • "addressInformation": {
    }
}
Response samples
{
  • "payment_methods": [
    ]
}

set guest shipping address and billing address

set guest shipping address and billing address

Request
path Parameters
cartId
required
integer
Request Body schema:
optional
required
object (checkout-data-shipping-information-interface)

Interface ShippingInformationInterface

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/rest/V1/carts/{cartId}/shipping-information
Request samples
{
  • "addressInformation": {
    }
}
Response samples
{
  • "payment_methods": [
    ]
}

Place order for guest

Use this call to convert an order quote to an order by processing payments for guest

Request
path Parameters
cartId
required
string
Request Body schema: application/json
optional
email
required
string
required
object (quote-data-payment-interface)

Interface PaymentInterface

object (quote-data-address-interface)

Interface AddressInterface

Responses
200

200 Success.

400

400 Bad Request

default

Unexpected error

post/rest/V1/guest-carts/{cartId}/payment-information
Request samples
application/json
{
  • "email": "string",
  • "paymentMethod": {
    },
  • "billingAddress": {
    }
}
Response samples
application/json
0
0

Place order for customer

Use this call to convert an order quote to an order by processing payments.

Request
Request Body schema:
optional
required
object (quote-data-payment-interface)

Interface PaymentInterface

object (quote-data-address-interface)

Interface AddressInterface

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

post/rest/V1/carts/mine/payment-information
Request samples
{
  • "paymentMethod": {
    },
  • "billingAddress": {
    }
}
Response samples
0
0

Get invoice list

Lists invoices 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 http://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

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/invoices
Response samples
{
  • "items": [
    ],
  • "total_count": 0
}

Create invoice

Native API call to create an invoice once an order has been processed.

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

Invoice interface. An invoice is a record of the receipt of payment for an order.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/rest/V1/invoices
Request samples
{
  • "entity": {
    }
}
Response samples
{
  • "base_currency_code": "string",
  • "base_discount_amount": 0,
  • "base_grand_total": 0,
  • "base_discount_tax_compensation_amount": 0,
  • "base_shipping_amount": 0,
  • "base_shipping_discount_tax_compensation_amnt": 0,
  • "base_shipping_incl_tax": 0,
  • "base_shipping_tax_amount": 0,
  • "base_subtotal": 0,
  • "base_subtotal_incl_tax": 0,
  • "base_tax_amount": 0,
  • "base_total_refunded": 0,
  • "base_to_global_rate": 0,
  • "base_to_order_rate": 0,
  • "billing_address_id": 0,
  • "can_void_flag": 0,
  • "created_at": "string",
  • "discount_amount": 0,
  • "discount_description": "string",
  • "email_sent": 0,
  • "entity_id": 0,
  • "global_currency_code": "string",
  • "grand_total": 0,
  • "discount_tax_compensation_amount": 0,
  • "increment_id": "string",
  • "is_used_for_refund": 0,
  • "order_currency_code": "string",
  • "order_id": 0,
  • "shipping_address_id": 0,
  • "shipping_amount": 0,
  • "shipping_discount_tax_compensation_amount": 0,
  • "shipping_incl_tax": 0,
  • "shipping_tax_amount": 0,
  • "state": 0,
  • "store_currency_code": "string",
  • "store_id": 0,
  • "store_to_base_rate": 0,
  • "store_to_order_rate": 0,
  • "subtotal": 0,
  • "subtotal_incl_tax": 0,
  • "tax_amount": 0,
  • "total_qty": 0,
  • "transaction_id": "string",
  • "updated_at": "string",
  • "items": [
    ]
}
➔ Next to Order Management