Omnyfy Marketplace API (1.0.0)

Download OpenAPI specification:Download

E-mail: marshall.lee@omnyfy.com License: Apache 2.0

Omnyfy Marketplace API

Vendor

Get marketplace vendor specific content

Get vendors from marketplace

Get a list of all vendors from the marketplace.

Request

query Parameters

searchCriteria[pageSize] required	integer setup page size for pagination
searchCriteria[currentPage] required	integer setup current page for pagination

Responses

200

search results matching criteria

404

specified content not found

get/rest/V1/vendors

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/vendors?searchCriteria%5BpageSize%5D=0&searchCriteria%5BcurrentPage%5D=0'

Response samples

application/json

[{"items": [{"id": 7,
"name": "Swords Select Wine & Beer",
"status": 1,
"phone": "0413 489 596",
"email": "Mr.tonylingua@getnada.com",
"description": "Swords Select stock a huge range of local and international craft beer, commercial and cleanskin wines.",
"logo": "swords-select-logo-400px.png",
"type_id": 1,
"attribute_set_id": 1
}
],
"search_criteria": {"page_size": 10,
"current_page": 1
},
"total_count": 99
}
]

Get Vendor details

Get basic details of the Vendor including the Attribute set of the Vendor (Marshall need to add API to get all Vendor Attribute Details)

Request

path Parameters

vendor_id

required

integer

pass a vendor id to retreive vendor details.

Responses

200

vendor details

400

invalid input, object invalid

404

specified content not found

get/rest/V1/vendors/id/{vendor_id}

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/vendors/id/{vendor_id}'

Locations

Get marketplace vendor location information

get Vendor locations

Vendor locations refer to warehouses of office locations of Vendors (if using Service Booking Feature Set). Use this call to get a list of all Vendor Locations.

Request

query Parameters

searchCriteria[pageSize]	integer setup page size for pagination
searchCriteria[currentPage]	integer setup current page for pagination

Responses

200

search results matching criteria

404

specified content not found

get/rest/V1/locations

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/locations?searchCriteria%5BpageSize%5D=0&searchCriteria%5BcurrentPage%5D=0'

Response samples

application/json

[{"items": [{"id": 7,
"vendor_id": 4,
"location_name": "Test Location 2 – Do not use",
"priority": 999,
"latitude": -37.8318,
"longitude": 144.9561,
"vendor_name": "Test Vendor",
"name": "Test Vendor's Location",
"link": "https://smm.omnyfy.com/booking/practice/view/id/1/",
"is_warehouse": 0,
"status": 0,
"vendor_type_id": 1,
"attribute_set_id": 9
}
],
"search_criteria": {"page_size": 10,
"current_page": 1
},
"total_count": 99
}
]

Get Location Details

The Vendor Location will return the address of the location and other specific location attributes. Parse the location ID to receive specific details of that location.

Request

path Parameters

location_id

required

integer

Responses

200

vendor details

400

invalid input, object invalid

404

specified content not found

get/rest/V1/locations/id/{location_id}

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/locations/id/{location_id}'

Response samples

application/json

{"id": 7,
"vendor_id": 4,
"location_name": "Test Location 2 – Do not use",
"priority": 999,
"latitude": -37.8318,
"longitude": 144.9561,
"vendor_name": "Test Vendor",
"name": "Test Vendor's Location",
"link": "https://smm.omnyfy.com/booking/practice/view/id/1/",
"is_warehouse": 0,
"status": 0,
"vendor_type_id": 1,
"attribute_set_id": 9
}

Products

APIs for maketplace owner to manager vendor products.

catalogProductRepositoryV1GetListGet

Get product list

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.
vendor_id	integer Specify vendor id to filter products.

Responses

200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/products

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/products?searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5BconditionType%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bdirection%5D=string&searchCriteria%5BpageSize%5D=0&searchCriteria%5BcurrentPage%5D=0&vendor_id=0'

Response samples

200
401
default

{"items": [{"id": 0,
"sku": "string",
"name": "string",
"attribute_set_id": 0,
"price": 0,
"status": 0,
"visibility": 0,
"type_id": "string",
"created_at": "string",
"updated_at": "string",
"weight": 0,
"extension_attributes": {"website_ids": [0
]
},
"product_links": [{"sku": "string",
"link_type": "string",
"linked_product_sku": "string",
"linked_product_type": "string",
"position": 0,
"extension_attributes": {"qty": 0
}
}
],
"media_gallery_entries": [{"id": 0,
"media_type": "string",
"label": "string",
"position": 0,
"disabled": true,
"types": ["string"
],
"file": "string",
"content": {"base64_encoded_data": "string",
"type": "string",
"name": "string"
}
}
],
"tier_prices": [{"customer_group_id": 0,
"qty": 0,
"value": 0
}
],
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

Create or update product

Native call to create a product. Use the Inventory API to assign the product to a specific Vendor on the marketplace

Request

Request Body schema: application/json

required	object (catalog-data-product-interface)
saveOptions	boolean

Responses

200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

post/rest/V1/products

Request samples

application/json

{"product": {"id": 0,
"sku": "string",
"name": "string",
"attribute_set_id": 0,
"price": 0,
"status": 0,
"visibility": 0,
"type_id": "string",
"created_at": "string",
"updated_at": "string",
"weight": 0,
"extension_attributes": {"website_ids": [0
]
},
"product_links": [{"sku": "string",
"link_type": "string",
"linked_product_sku": "string",
"linked_product_type": "string",
"position": 0,
"extension_attributes": {"qty": 0
}
}
],
"media_gallery_entries": [{"id": 0,
"media_type": "string",
"label": "string",
"position": 0,
"disabled": true,
"types": ["string"
],
"file": "string",
"content": {"base64_encoded_data": "string",
"type": "string",
"name": "string"
}
}
],
"tier_prices": [{"customer_group_id": 0,
"qty": 0,
"value": 0
}
],
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"saveOptions": true
}

Response samples

200
400
401
default

application/json

{"id": 0,
"sku": "string",
"name": "string",
"attribute_set_id": 0,
"price": 0,
"status": 0,
"visibility": 0,
"type_id": "string",
"created_at": "string",
"updated_at": "string",
"weight": 0,
"extension_attributes": {"website_ids": [0
]
},
"product_links": [{"sku": "string",
"link_type": "string",
"linked_product_sku": "string",
"linked_product_type": "string",
"position": 0,
"extension_attributes": {"qty": 0
}
}
],
"media_gallery_entries": [{"id": 0,
"media_type": "string",
"label": "string",
"position": 0,
"disabled": true,
"types": ["string"
],
"file": "string",
"content": {"base64_encoded_data": "string",
"type": "string",
"name": "string"
}
}
],
"tier_prices": [{"customer_group_id": 0,
"qty": 0,
"value": 0
}
],
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}

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}

Request samples

curl -i -X DELETE \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/products/{sku}'

Response samples

200
400
401
default

application/json

true

Get category list

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.

Responses

200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/V1/categories/list

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/V1/categories/list?searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5BconditionType%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bdirection%5D=string'

Response samples

200
401
default

application/json

{"items": [{"id": 0,
"parent_id": 0,
"name": "string",
"is_active": true,
"position": 0,
"level": 0,
"children": "string",
"created_at": "string",
"updated_at": "string",
"path": "string",
"available_sort_by": ["string"
],
"include_in_menu": true,
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

Inventory

Assign product to vendor and vendor location. Manage inventory level on vendor location

Assign product to specific Vendor

Assign the product to a specific Vendor on the marketplace

Request

path Parameters

product_id

required

string

Request Body schema: application/json

vendor_ids

Array of integers (vendor-id)

Responses

200

200 Success.

post/rest/V1/vendor_product/update/{product_id}

Request samples

application/json

{"vendor_ids": [1
]
}

Response samples

application/json

{"success": true,
"message": "Assigned product 9527 to vendors"
}

Update the product inventory

Update the product inventory to specific Vendor's Location / Warehuse on the marketplace

Request

path Parameters

product_id

required

string

Request Body schema: application/json

Array of objects (product-inventory-assignment)

Responses

200

200 Success.

post/rest/V1/location_product/{product_id}

Request samples

application/json

{"inventories": [{"location_id": 2,
"qty": 100
}
]
}

Response samples

application/json

{"success": true,
"message": "product 9527 inventory updated"
}

Get inventory for a specific product

Request

path Parameters

product_id

required

string

Responses

200

200 Success.

get/rest/V1/location_product/{product_id}

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/location_product/{product_id}'

Response samples

application/json

{"inventory": [{"location_id": 2,
"qty": 100
}
],
"total": 9999,
"count": 2
}

Customer

Manage customers

create a customer on the marketplace

Native call to create a customer on the marketplace. The Create Customer API enables the creation of a Customer in the platform and will also trigger new customer email notification

Request

Request Body schema: application/json

required	object (customer-data-customer-interface) Customer interface.
password	string
redirectUrl	string

Responses

200

200 Success.

500

Internal Server error

default

Unexpected error

post/rest/V1/customers

Request samples

application/json

{"customer": {"id": 0,
"group_id": 0,
"default_billing": "string",
"default_shipping": "string",
"confirmation": "string",
"created_at": "string",
"updated_at": "string",
"created_in": "string",
"dob": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"gender": 0,
"store_id": 0,
"taxvat": "string",
"website_id": 0,
"addresses": [{"id": 0,
"customer_id": 0,
"region": {"region_code": "string",
"region": "string",
"region_id": 0,
"extension_attributes": { }
},
"region_id": 0,
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"default_shipping": true,
"default_billing": true,
"extension_attributes": { },
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
],
"disable_auto_group_change": 0,
"extension_attributes": {"is_subscribed": true,
"amazon_id": "string",
"vertex_customer_code": "string"
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"password": "string",
"redirectUrl": "string"
}

Response samples

200
500
default

application/json

{"id": 0,
"group_id": 0,
"default_billing": "string",
"default_shipping": "string",
"confirmation": "string",
"created_at": "string",
"updated_at": "string",
"created_in": "string",
"dob": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"gender": 0,
"store_id": 0,
"taxvat": "string",
"website_id": 0,
"addresses": [{"id": 0,
"customer_id": 0,
"region": {"region_code": "string",
"region": "string",
"region_id": 0,
"extension_attributes": { }
},
"region_id": 0,
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"default_shipping": true,
"default_billing": true,
"extension_attributes": { },
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
],
"disable_auto_group_change": 0,
"extension_attributes": {"is_subscribed": true,
"amazon_id": "string",
"vertex_customer_code": "string"
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}

get customer access token

Create access token for admin given the customer credentials.

Request

Request Body schema: application/json

username required	string
password required	string

Responses

200

200 Success.

400

400 Bad Request

default

Unexpected error

post/rest/V1/integration/customer/token

Request samples

application/json

{"username": "string",
"password": "string"
}

Response samples

200
400
default

application/json

"string"

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

Request samples

curl -i -X POST \
  https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/guest-carts

Response samples

200
400
default

"string"

Save quote for customer

Save quote

Request

Request Body schema: application/json

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": {"id": 0,
"created_at": "string",
"updated_at": "string",
"converted_at": "string",
"is_active": true,
"is_virtual": true,
"items": [{"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": { }
}
],
"items_count": 0,
"items_qty": 0,
"customer": {"id": 0,
"group_id": 0,
"default_billing": "string",
"default_shipping": "string",
"confirmation": "string",
"created_at": "string",
"updated_at": "string",
"created_in": "string",
"dob": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"gender": 0,
"store_id": 0,
"taxvat": "string",
"website_id": 0,
"addresses": [{"id": 0,
"customer_id": 0,
"region": {"region_code": "string",
"region": "string",
"region_id": 0,
"extension_attributes": { }
},
"region_id": 0,
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"default_shipping": true,
"default_billing": true,
"extension_attributes": { },
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
],
"disable_auto_group_change": 0,
"extension_attributes": {"is_subscribed": true,
"amazon_id": "string",
"vertex_customer_code": "string"
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"billing_address": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [{"attribute_code": "string",
"value": "string"
}
]
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"reserved_order_id": "string",
"orig_order_id": 0,
"currency": {"global_currency_code": "string",
"base_currency_code": "string",
"store_currency_code": "string",
"quote_currency_code": "string",
"store_to_base_rate": 0,
"store_to_quote_rate": 0,
"base_to_global_rate": 0,
"base_to_quote_rate": 0,
"extension_attributes": { }
},
"customer_is_guest": true,
"customer_note": "string",
"customer_note_notify": true,
"customer_tax_class_id": 0,
"store_id": 0,
"extension_attributes": {"shipping_assignments": [{"shipping": {"address": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": [null
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [ ]
},
"custom_attributes": [null
]
},
"method": "string",
"extension_attributes": { }
},
"items": [{"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": { }
}
],
"extension_attributes": { }
}
],
"amazon_order_reference_id": "string"
}
}
}

Response samples

401
default

application/json

{"message": "string",
"errors": [{"message": "string",
"parameters": [{"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 0,
"parameters": [{"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"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

Request samples

curl -i -X POST \
  https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/carts/mine

Response samples

200
400
401
default

application/json

0

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

Request samples

curl -i -X GET \
  https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/carts/mine

Response samples

200
400
401
default

{"id": 0,
"created_at": "string",
"updated_at": "string",
"converted_at": "string",
"is_active": true,
"is_virtual": true,
"items": [{"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": { }
}
],
"items_count": 0,
"items_qty": 0,
"customer": {"id": 0,
"group_id": 0,
"default_billing": "string",
"default_shipping": "string",
"confirmation": "string",
"created_at": "string",
"updated_at": "string",
"created_in": "string",
"dob": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"gender": 0,
"store_id": 0,
"taxvat": "string",
"website_id": 0,
"addresses": [{"id": 0,
"customer_id": 0,
"region": {"region_code": "string",
"region": "string",
"region_id": 0,
"extension_attributes": { }
},
"region_id": 0,
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"default_shipping": true,
"default_billing": true,
"extension_attributes": { },
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
],
"disable_auto_group_change": 0,
"extension_attributes": {"is_subscribed": true,
"amazon_id": "string",
"vertex_customer_code": "string"
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"billing_address": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [{"attribute_code": "string",
"value": "string"
}
]
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"reserved_order_id": "string",
"orig_order_id": 0,
"currency": {"global_currency_code": "string",
"base_currency_code": "string",
"store_currency_code": "string",
"quote_currency_code": "string",
"store_to_base_rate": 0,
"store_to_quote_rate": 0,
"base_to_global_rate": 0,
"base_to_quote_rate": 0,
"extension_attributes": { }
},
"customer_is_guest": true,
"customer_note": "string",
"customer_note_notify": true,
"customer_tax_class_id": 0,
"store_id": 0,
"extension_attributes": {"shipping_assignments": [{"shipping": {"address": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [null
]
},
"custom_attributes": [{"attribute_code": null,
"value": null
}
]
},
"method": "string",
"extension_attributes": { }
},
"items": [{"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": { }
}
],
"extension_attributes": { }
}
],
"amazon_order_reference_id": "string"
}
}

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/

Request samples

curl -i -X POST \
  https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/carts/

Response samples

200
400
401
default

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

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/carts/{cartId}/items'

Response samples

200
400
401
default

[{"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.

Request

path Parameters

cartId required	string
itemId required	string

Request Body schema:
application/json
application/json
application/xml

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": {"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": { }
}
}

Response samples

200
400
401
default

{"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.

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}

Request samples

curl -i -X DELETE \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/carts/{cartId}/items/{itemId}'

Response samples

200
400
401
default

true

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

Request samples

curl -i -X GET \
  https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/carts/mine/items

Response samples

200
400
401
default

[{"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.

Request

Request Body schema:
application/json
application/json
application/xml

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": {"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": { }
}
}

Response samples

200
400
401
default

{"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.

Request

path Parameters

itemId

required

string

Request Body schema:
application/json
application/json
application/xml

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": {"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": { }
}
}

Response samples

200
400
401
default

{"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.

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}

Request samples

curl -i -X DELETE \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/carts/mine/items/{itemId}'

Response samples

200
400
401
default

true

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

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/guest-carts/{cartId}/items'

Response samples

200
400
default

[{"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.

Request

path Parameters

cartId

required

string

Request Body schema:
application/json
application/json
application/xml

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": {"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": { }
}
}

Response samples

200
400
default

{"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.

Request

path Parameters

cartId required	string
itemId required	string

Request Body schema:
application/json
application/json
application/xml

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": {"item_id": 0,
"sku": "string",
"qty": 0,
"name": "string",
"price": 0,
"product_type": "string",
"quote_id": "string",
"product_option": { }
}
}

Response samples

200
400
default

{"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}

Request samples

curl -i -X DELETE \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/guest-carts/{cartId}/items/{itemId}'

Response samples

200
400
default

true

set customer shipping address and billing address

Request

Request Body schema:
application/json
application/json
application/xml

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": {"shipping_address": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [{"attribute_code": "string",
"value": "string"
}
]
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"billing_address": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [{"attribute_code": "string",
"value": "string"
}
]
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"shipping_method_code": "string",
"shipping_carrier_code": "string",
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
}

Response samples

200
401
default

{"payment_methods": [{"code": "string",
"title": "string"
}
]
}

set guest shipping address and billing address

Request

path Parameters

cartId

required

integer

Request Body schema:
application/json
application/json
application/xml

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": {"shipping_address": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [{"attribute_code": "string",
"value": "string"
}
]
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"billing_address": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [{"attribute_code": "string",
"value": "string"
}
]
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
},
"shipping_method_code": "string",
"shipping_carrier_code": "string",
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
}

Response samples

200
401
default

{"payment_methods": [{"code": "string",
"title": "string"
}
]
}

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

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": {"po_number": "string",
"method": "string",
"additional_data": ["string"
],
"extension_attributes": {"agreement_ids": ["string"
]
}
},
"billingAddress": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [{"attribute_code": "string",
"value": "string"
}
]
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
}

Response samples

200
400
default

application/json

0

Place order for customer

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

Request

Request Body schema:
application/json
application/json
application/xml

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": {"po_number": "string",
"method": "string",
"additional_data": ["string"
],
"extension_attributes": {"agreement_ids": ["string"
]
}
},
"billingAddress": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [{"attribute_code": "string",
"value": "string"
}
]
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
}

Response samples

200
400
401
default

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

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/invoices?searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5BconditionType%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bdirection%5D=string&searchCriteria%5BpageSize%5D=0&searchCriteria%5BcurrentPage%5D=0'

Response samples

200
401
default

{"items": [{"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": [{"additional_data": "string",
"base_cost": 0,
"base_discount_amount": 0,
"base_discount_tax_compensation_amount": 0,
"base_price": 0,
"base_price_incl_tax": 0,
"base_row_total": 0,
"base_row_total_incl_tax": 0,
"base_tax_amount": 0,
"description": "string",
"discount_amount": 0,
"entity_id": 0,
"discount_tax_compensation_amount": 0,
"name": "string",
"parent_id": 0,
"price": 0,
"price_incl_tax": 0,
"product_id": 0,
"row_total": 0,
"row_total_incl_tax": 0,
"sku": "string",
"tax_amount": 0,
"order_item_id": 0,
"qty": 0
}
]
}
],
"total_count": 0
}

Create invoice

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

Request

Request Body schema:
application/json
application/json
application/xml

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": {"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": [{"additional_data": "string",
"base_cost": 0,
"base_discount_amount": 0,
"base_discount_tax_compensation_amount": 0,
"base_price": 0,
"base_price_incl_tax": 0,
"base_row_total": 0,
"base_row_total_incl_tax": 0,
"base_tax_amount": 0,
"description": "string",
"discount_amount": 0,
"entity_id": 0,
"discount_tax_compensation_amount": 0,
"name": "string",
"parent_id": 0,
"price": 0,
"price_incl_tax": 0,
"product_id": 0,
"row_total": 0,
"row_total_incl_tax": 0,
"sku": "string",
"tax_amount": 0,
"order_item_id": 0,
"qty": 0
}
]
}
}

Response samples

200
401
default

{"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": [{"additional_data": "string",
"base_cost": 0,
"base_discount_amount": 0,
"base_discount_tax_compensation_amount": 0,
"base_price": 0,
"base_price_incl_tax": 0,
"base_row_total": 0,
"base_row_total_incl_tax": 0,
"base_tax_amount": 0,
"description": "string",
"discount_amount": 0,
"entity_id": 0,
"discount_tax_compensation_amount": 0,
"name": "string",
"parent_id": 0,
"price": 0,
"price_incl_tax": 0,
"product_id": 0,
"row_total": 0,
"row_total_incl_tax": 0,
"sku": "string",
"tax_amount": 0,
"order_item_id": 0,
"qty": 0
}
]
}

Order Management

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

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/orders?searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5BconditionType%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bdirection%5D=string&searchCriteria%5BpageSize%5D=0&searchCriteria%5BcurrentPage%5D=0'

Response samples

200
401
default

application/json

{"items": [{"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_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": [{"additional_data": "string",
"amount_refunded": 0,
"applied_rule_ids": "string",
"base_amount_refunded": 0,
"base_cost": 0,
"base_discount_amount": 0,
"base_discount_invoiced": 0,
"base_discount_refunded": 0,
"base_discount_tax_compensation_amount": 0,
"base_discount_tax_compensation_invoiced": 0,
"base_discount_tax_compensation_refunded": 0,
"base_original_price": 0,
"base_price": 0,
"base_price_incl_tax": 0,
"base_row_invoiced": 0,
"base_row_total": 0,
"base_row_total_incl_tax": 0,
"base_tax_amount": 0,
"base_tax_before_discount": 0,
"base_tax_invoiced": 0,
"base_tax_refunded": 0,
"base_weee_tax_applied_amount": 0,
"base_weee_tax_applied_row_amnt": 0,
"base_weee_tax_disposition": 0,
"base_weee_tax_row_disposition": 0,
"created_at": "string",
"description": "string",
"discount_amount": 0,
"discount_invoiced": 0,
"discount_percent": 0,
"discount_refunded": 0,
"event_id": 0,
"ext_order_item_id": "string",
"free_shipping": 0,
"gw_base_price": 0,
"gw_base_price_invoiced": 0,
"gw_base_price_refunded": 0,
"gw_base_tax_amount": 0,
"gw_base_tax_amount_invoiced": 0,
"gw_base_tax_amount_refunded": 0,
"gw_id": 0,
"gw_price": 0,
"gw_price_invoiced": 0,
"gw_price_refunded": 0,
"gw_tax_amount": 0,
"gw_tax_amount_invoiced": 0,
"gw_tax_amount_refunded": 0,
"discount_tax_compensation_amount": 0,
"discount_tax_compensation_canceled": 0,
"discount_tax_compensation_invoiced": 0,
"discount_tax_compensation_refunded": 0,
"is_qty_decimal": 0,
"is_virtual": 0,
"item_id": 0,
"locked_do_invoice": 0,
"locked_do_ship": 0,
"name": "string",
"no_discount": 0,
"order_id": 0,
"original_price": 0,
"parent_item_id": 0,
"price": 0,
"price_incl_tax": 0,
"product_id": 0,
"product_type": "string",
"qty_backordered": 0,
"qty_canceled": 0,
"qty_invoiced": 0,
"qty_ordered": 0,
"qty_refunded": 0,
"qty_returned": 0,
"qty_shipped": 0,
"quote_item_id": 0,
"row_invoiced": 0,
"row_total": 0,
"row_total_incl_tax": 0,
"row_weight": 0,
"sku": "string",
"store_id": 0,
"tax_amount": 0,
"tax_before_discount": 0,
"tax_canceled": 0,
"tax_invoiced": 0,
"tax_percent": 0,
"tax_refunded": 0,
"updated_at": "string",
"weee_tax_applied": "string",
"weee_tax_applied_amount": 0,
"weee_tax_applied_row_amount": 0,
"weee_tax_disposition": 0,
"weee_tax_row_disposition": 0,
"weight": 0,
"parent_item": { }
}
],
"billing_address": {"address_type": "string",
"city": "string",
"company": "string",
"country_id": "string",
"customer_address_id": 0,
"customer_id": 0,
"email": "string",
"entity_id": 0,
"fax": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"parent_id": 0,
"postcode": "string",
"prefix": "string",
"region": "string",
"region_code": "string",
"region_id": 0,
"street": ["string"
],
"suffix": "string",
"telephone": "string",
"vat_id": "string",
"vat_is_valid": 0,
"vat_request_date": "string",
"vat_request_id": "string",
"vat_request_success": 0
}
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

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

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/orders/items?searchCriteria%5BpageSize%5D=0&searchCriteria%5BcurrentPage%5D=0&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5BconditionType%5D=string'

Get the Click and Collect Status of an order

Get the Click and Collect Status of an order. Required for processing click and collect orders

Request

Request Body schema: application/json

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": {"clickcollect_order_id": "string",
"order_id": "string",
"status": "string",
"store_id": "string",
"email_sent": "string",
"created_by": "string",
"created_at": "string",
"updated_by": "string",
"updated_at": "string",
"total_item_count": "string",
"vendor_id": "string",
"location_id": "string"
}
}

Response samples

401
default

application/json

{"message": "string",
"errors": [{"message": "string",
"parameters": [{"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 0,
"parameters": [{"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}

Shipment

Estimate shipping by address and return list of available shipping methods

Request

path Parameters

cartId

required

string

Request Body schema:
application/json
application/json
application/xml

required

object (quote-data-address-interface)

Interface AddressInterface

Responses

200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/rest/V1/carts/{cartId}/estimate-shipping-methods

Request samples

{"address": {"id": 0,
"region": "string",
"region_id": 0,
"region_code": "string",
"country_id": "string",
"street": ["string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 0,
"email": "string",
"same_as_billing": 0,
"customer_address_id": 0,
"save_in_address_book": 0,
"extension_attributes": {"checkout_fields": [{"attribute_code": "string",
"value": "string"
}
]
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
}

Response samples

200
401
default

[{"carrier_code": "string",
"method_code": "string",
"carrier_title": "string",
"method_title": "string",
"amount": 0,
"base_amount": 0,
"available": true,
"error_message": "string",
"price_excl_tax": 0,
"price_incl_tax": 0
}
]

get shipment

Loads a specified shipment.

Request

path Parameters

required

integer

The shipment ID.

Responses

200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/shipment/{id}

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/shipment/{id}'

Response samples

200
401
default

{"billing_address_id": 0,
"created_at": "string",
"customer_id": 0,
"email_sent": 0,
"entity_id": 0,
"increment_id": "string",
"order_id": 0,
"packages": [{"extension_attributes": { }
}
],
"shipment_status": 0,
"shipping_address_id": 0,
"shipping_label": "string",
"store_id": 0,
"total_qty": 0,
"total_weight": 0,
"updated_at": "string",
"items": [{"additional_data": "string",
"description": "string",
"entity_id": 0,
"name": "string",
"parent_id": 0,
"price": 0,
"product_id": 0,
"row_total": 0,
"sku": "string",
"weight": 0,
"extension_attributes": { },
"order_item_id": 0,
"qty": 0
}
],
"tracks": [{"order_id": 0,
"created_at": "string",
"entity_id": 0,
"parent_id": 0,
"updated_at": "string",
"weight": 0,
"qty": 0,
"description": "string",
"extension_attributes": { },
"track_number": "string",
"title": "string",
"carrier_code": "string"
}
],
"comments": [{"is_customer_notified": 0,
"parent_id": 0,
"extension_attributes": { },
"comment": "string",
"is_visible_on_front": 0,
"created_at": "string",
"entity_id": 0
}
],
"extension_attributes": {"ext_shipment_id": "string",
"ext_return_shipment_id": "string",
"ext_location_id": "string",
"ext_tracking_url": "string",
"ext_tracking_reference": "string"
}
}

Get shipment list

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

Request samples

curl -i -X GET \
  'https://demo.omnyfy.com/om87/OmnyfyMarketplaceAPI/1.0.0/rest/V1/shipments?searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D=string&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5BconditionType%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bfield%5D=string&searchCriteria%5BsortOrders%5D%5B0%5D%5Bdirection%5D=string&searchCriteria%5BpageSize%5D=0&searchCriteria%5BcurrentPage%5D=0'

Response samples

200
401
default

{"items": [{"billing_address_id": 0,
"created_at": "string",
"customer_id": 0,
"email_sent": 0,
"entity_id": 0,
"increment_id": "string",
"order_id": 0,
"packages": [{"extension_attributes": { }
}
],
"shipment_status": 0,
"shipping_address_id": 0,
"shipping_label": "string",
"store_id": 0,
"total_qty": 0,
"total_weight": 0,
"updated_at": "string",
"items": [{"additional_data": "string",
"description": "string",
"entity_id": 0,
"name": "string",
"parent_id": 0,
"price": 0,
"product_id": 0,
"row_total": 0,
"sku": "string",
"weight": 0,
"extension_attributes": { },
"order_item_id": 0,
"qty": 0
}
],
"tracks": [{"order_id": 0,
"created_at": "string",
"entity_id": 0,
"parent_id": 0,
"updated_at": "string",
"weight": 0,
"qty": 0,
"description": "string",
"extension_attributes": { },
"track_number": "string",
"title": "string",
"carrier_code": "string"
}
],
"comments": [{"is_customer_notified": 0,
"parent_id": 0,
"extension_attributes": { },
"comment": "string",
"is_visible_on_front": 0,
"created_at": "string",
"entity_id": 0
}
],
"extension_attributes": {"ext_shipment_id": "string",
"ext_return_shipment_id": "string",
"ext_location_id": "string",
"ext_tracking_url": "string",
"ext_tracking_reference": "string"
}
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

Omnyfy Marketplace API (1.0.0)

Vendor

Get vendors from marketplace

query Parameters

Get Vendor details

path Parameters

Locations

get Vendor locations

query Parameters

Get Location Details

path Parameters

Products

catalogProductRepositoryV1GetListGet

query Parameters

Create or update product

Request Body schema: application/json

Delete product

path Parameters

Get category list

query Parameters

Inventory

Assign product to specific Vendor

path Parameters

Request Body schema: application/json

Update the product inventory

path Parameters

Request Body schema: application/json

Get inventory for a specific product

path Parameters

Customer

create a customer on the marketplace

Request Body schema: application/json

get customer access token

Request Body schema: application/json

Sales

Save quote for customer

Save quote for customer

Request Body schema: application/json

Create quote

Get quote

Creates an empty cart and quote for a guest.

Lists cart items

path Parameters

Add/update the specified cart item.

path Parameters

Request Body schema: application/jsonapplication/jsonapplication/xml

Removes the specified item from the specified cart.

path Parameters

Lists items that are assigned to a specified cart.

Add/update the specified cart item.

Request Body schema: application/jsonapplication/jsonapplication/xml

Add/update the specified cart item.

path Parameters

Request Body schema: application/jsonapplication/jsonapplication/xml

Removes the specified item from the specified cart.

path Parameters

List items that are assigned to a specified cart.

path Parameters

Add/update the specified cart item.

path Parameters

Request Body schema: application/jsonapplication/jsonapplication/xml

Add/update the specified cart item.

path Parameters

Request Body schema: application/jsonapplication/jsonapplication/xml

Remove the specified item from the specified cart

path Parameters

set customer shipping address and billing address

Request Body schema: application/jsonapplication/jsonapplication/xml

set guest shipping address and billing address

path Parameters

Request Body schema: application/jsonapplication/jsonapplication/xml

Place order for guest

path Parameters

Request Body schema: application/json

Place order for customer

Request Body schema: application/jsonapplication/jsonapplication/xml

Get invoice list

query Parameters

Create invoice

Request Body schema: application/jsonapplication/jsonapplication/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml

Request Body schema:
application/json
application/json
application/xml