API reference

This reference is generated from schema.graphql at commit fbf0d6e of the RaviFurnitures API. It lists only the operations published for integrations, and the types those operations use.

Each operation shows the permission an API key needs to call it.

Connectivity

Check that you can reach the API.

Operation	Kind	Returns	Permission
ping	query	String!	None (public)

Orders to accounting

Read orders and refunds into an accounting system.

Operation	Kind	Returns	Permission
orders	query	OrderConnection!	MANAGE_ORDERS
order	query	Order	MANAGE_ORDERS
refunds	query	RefundConnection!	MANAGE_ORDERS

Catalogue and stock feed

Read products, warehouses and low-stock items.

Operation	Kind	Returns	Permission
products	query	ProductConnection!	None (public)
product	query	Product	None (public)
warehouses	query	[Warehouse!]!	MANAGE_PRODUCTS
lowStock	query	[StockInfo!]!	MANAGE_PRODUCTS

Consignment to ERP

Read consignments, consignment invoices, retailer statements and retailer payments into an ERP.

Operation	Kind	Returns	Permission
consignments	query	[Consignment!]!	MANAGE_CONSIGNMENT
consignmentInvoices	query	[ConsignmentInvoice!]!	MANAGE_CONSIGNMENT
retailerStatements	query	[RetailerStatement!]!	MANAGE_SETTLEMENTS
retailerPayments	query	[RetailerPayment!]!	MANAGE_SETTLEMENTS

Types

Objects

Address, AplusImage, AplusModule, Attribute, AttributeValue, Brand, BrandMedia, Category, CategoryMedia, Consignment, ConsignmentInvoice, ConsignmentLine, CreditNote, DigitalContent, EmiPlan, Fulfillment, FulfillmentLine, GstBreakup, Invoice, MetadataItem, Money, Order, OrderConnection, OrderEdge, OrderEvent, OrderIssue, OrderLine, OrderLineProtection, OrderRating, PageInfo, Payment, Product, ProductCode, ProductConnection, ProductEdge, ProductMedia, ProductType, ProductVariant, Refund, RefundConnection, RefundEdge, RetailerPayment, RetailerPaymentAllocation, RetailerStatement, RetailerStatementLine, SalesChannel, Showroom, ShowroomHours, StockInfo, Warehouse

Input objects

AttributeFilterInput, ProductFilterInput

Enums

AddressLabel, AplusModuleType, AttributeInputType, ConsignmentKind, ConsignmentStatus, CustomerSegment, DeliveryMode, DigitalContentKind, FulfillmentStatus, IndianState, MediaType, OrderDeliveryMethod, OrderEventType, OrderIssueResolution, OrderIssueStatus, OrderIssueType, OrderPaymentMethod, OrderStatus, PaymentStatus, ProductSort, ProductStatus, RefundState, RetailerPaymentMethod, RetailerPaymentStatus, RetailerStatementStatus, SalesChannelKind, ShippingClass, ShowroomOwnership, TransportMode, VideoProvider, WarehouseKind

Scalars

Date, DateTime, JSON, Time

Built-in GraphQL scalars used: Boolean, Float, ID, Int, String.