> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.quivo.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Submit request
> Submit a new order for processing, including essential details like delivery address, order identifier, and item positions.
## OpenAPI
````yaml /openapi.json post /orders
openapi: 3.0.1
info:
title: Connector
version: 80f7edc, 2026-01-23T12:01:00Z
description: Enhanced Quivo API documentation with additional descriptions and examples
contact:
name: Quivo Support
email: support@quivo.co
url: https://quivo.co
license:
name: Proprietary
url: https://quivo.co/terms
termsOfService: https://quivo.co/terms
servers:
- url: https://api.quivo.co/
description: Production API server for Quivo Connector
security: []
tags:
- name: addresses
description: Manage stored addresses in the seller's address book
- name: apiKeyRequests
description: Request and manage API keys
- name: articles
description: Create and manage product articles
- name: audits
description: Access audit logs and history
- name: bundles
description: Manage product bundles
- name: carriers
description: Get carrier information
- name: contacts
description: Manage contact information
- name: countries
description: Get country information
- name: currencies
description: Get currency information
- name: customerInquiries
description: Manage customer inquiries
- name: dashboards
description: Access dashboard data
- name: files
description: Manage file uploads and downloads
- name: fulfillmentPlans
description: Manage fulfillment plans
- name: inbounds
description: Manage inbound shipments
- name: items
description: Monitor and manage inventory items
- name: languages
description: Get language information
- name: notifications
description: Manage notifications
- name: orders
description: Create and manage fulfillment orders
- name: ping
description: Health check endpoint
- name: returnApp
description: Manage return applications
- name: returnLinks
description: Manage return links
- name: returns
description: Manage returns
- name: sellers
description: Get seller information
- name: shipments
description: Book and manage shipments
- name: shippingServiceGroups
description: Get shipping service groups
- name: shopOrders
description: Manage shop orders
- name: shops
description: Manage shops
- name: status
description: Get system status
- name: storedAddresses
description: Manage stored addresses
- name: subscriptionPackages
description: Manage subscription packages
- name: subscriptions
description: Manage webhook subscriptions
- name: track
description: Track shipments
- name: transports
description: Manage transport services
- name: users
description: Manage users
- name: warehouses
description: Get warehouse information
paths:
/orders:
post:
tags:
- orders
summary: Submit request
description: >-
Submit a new order for processing, including essential details like
delivery address, order identifier, and item positions.
operationId: orderPost
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderPost'
required: false
description: Request body data for Submit request
responses:
'200':
description: >-
Returns the result of the order creation attempt, including the
newly assigned 'orderId' if successful, or status and error details
if validation fails.
content:
application/json:
schema:
$ref: '#/components/schemas/OrderPostResult'
'400':
description: >-
Bad request - the request payload is invalid, missing required
fields, or contains invalid data.
'401':
description: >-
Unauthorized - authentication credentials are missing, invalid, or
expired.
'404':
description: >-
Not found - the requested resource does not exist or is not
accessible.
'500':
description: Internal server error - an unexpected error occurred on the server.
components:
schemas:
OrderPost:
required:
- deliveryAddress
- orderIdentifier
- orderReference
- positions
- sellerId
type: object
properties:
sellerId:
type: integer
description: The seller id to which this order belongs.
format: int64
warehouseId:
type: integer
description: >-
The id of the warehouse where the order gets processed. A list of
warehouse identifiers and names can be obtained by executing GET
/warehouses
format: int64
orderIdentifier:
maxLength: 40
minLength: 0
type: string
description: >-
A unique identifier to prevent duplicates of the same order in the
system. It can be the id of the order in the shop system or another
unique number
orderReference:
maxLength: 40
minLength: 0
type: string
description: >-
The orderReference is set from the customer to identify the order
easily.
Example: #DE38678
hasInvoiceAddress:
type: boolean
description: >-
Optional value indicating whether the invoice address is provided.
By default the delivery address is used as invoice address.
hasInvoiceData:
type: boolean
description: >-
Optional value indicating whether the invoice data is provided.
The invoice data includes currency and sales prices.
deliveryAddress:
$ref: '#/components/schemas/OrderPostDeliveryAddress'
invoiceAddress:
$ref: '#/components/schemas/OrderPostAddress'
orderDate:
type: string
description: The date when the order was placed.
format: date-time
currencyCode:
type: string
description: The currency in which the order was placed.
invoiceIds:
type: array
items:
type: string
description: The unique identifier for the invoices
comment:
maxLength: 250
minLength: 0
type: string
description: >-
Optional text which contains instructions for the fulfillment and is
sent to the warehouse.
positions:
maxItems: 2147483647
minItems: 1
type: array
description: The content of the order.
items:
$ref: '#/components/schemas/OrderPostPosition'
earliestDeliveryDate:
type: string
description: >-
Optional date which indicates the earliest allowed date of delivery
in ISO 8601 format.
Example: 2021-01-10
format: date
latestDeliveryDate:
type: string
description: >-
Optional date which indicates the latest allowed date of delivery in
ISO 8601 format.
Example: 2021-01-12
format: date
transportInsuranceAmount:
minimum: 0
exclusiveMinimum: true
type: number
description: >-
Optional amount which should get insured when booking the transport
for this order in EUR.
cashOnDeliveryAmount:
type: number
description: >-
Optional COD total amount parameter. If the amount is greater than
0, it will be processed as a COD shipment
cashOnDeliveryCurrency:
type: string
description: Optional COD currency.
shippingMethodIdentifier:
maxLength: 50
minLength: 0
type: string
description: >-
Optional identifier which indicates how the parcels should be
transported.
Example: UPSS
shippingMethodName:
maxLength: 100
minLength: 0
type: string
description: >-
Optional name which indicates how the parcels should be
transported.
Example: UPS Saver
tags:
type: array
description: Optional tags of this order
items:
type: string
trackingEnabled:
type: boolean
description: >-
Optional value setting whether to turn on/off tracking functionality
for an order. Additional charges will apply when set to true.
orderPriority:
maximum: 3
minimum: 1
type: integer
description: Optional value to prioritize order.
format: int32
orderReference2:
maxLength: 40
minLength: 0
type: string
description: |-
Optional value for additional orderReference
Example: #DE38678
customerPurchaseOrderNumber:
maxLength: 255
minLength: 0
type: string
description: >-
Optional value which specifies reference code that is assigned to a
purchase
Example: PO-89225
ssccLabel:
type: boolean
description: >-
Optional value setting whether to create ssccLabel or not based on
customerPurchaseOrderNumber value.
channelId:
maxLength: 10
minLength: 0
type: string
description: >-
Optional value which specifies the channel ID of the master client
of this order.
channelName:
maxLength: 100
minLength: 0
type: string
description: >-
Optional value which specifies the channel name of the master client
of this order.
Example: Obi E-Commerce
attachments:
type: array
description: Optional attachments parameter
items:
$ref: '#/components/schemas/OrderAttachmentPost'
customAttributes:
type: object
additionalProperties:
type: string
description: Optional value for custom attributes of order.
example: '{"attr1":"val1"}'
description: >-
Request payload for creating a new order. Contains essential order
details including delivery address, order identifier, item positions,
shipping preferences, and optional customer information.
OrderPostResult:
type: object
properties:
status:
type: string
description: >-
Indicates the overall status of the order creation attempt.
Typically "OK" on success, or an error status on failure.
field:
type: string
description: >-
On failure, this field indicates the specific request field that
caused the error (e.g., "deliveryAddress.countryIso2"). This field
is null on success.
message:
type: string
description: >-
A detailed, human-readable message describing the outcome of the
operation. This may contain success confirmation or a specific error
explanation.
orderId:
type: integer
format: int64
description: >-
The unique internal ID assigned to the new order upon successful
creation. This field is null on failure.
description: >-
Represents the outcome of an order creation request, indicating whether
the operation was successful (status) and, if successful, providing the
new orderId. It includes fields for error messages if the operation
failed.
OrderPostDeliveryAddress:
type: object
properties:
name:
type: string
description: >-
The first and lastname of the recipient.
Either name or company
is required.
company:
type: string
description: Name of the company.
Either name or company is required.
phone:
type: string
description: Phone number.
email:
type: string
description: E-Mail address.
street:
type: string
description: >-
Street (or Address Line 1).
This field is optional only when
latitude and longitude coordinates are provided.
street2:
type: string
description: Street (or Address Line 2).
This field is optional.
zip:
type: string
description: >-
ZIP Code.
The ZIP code is optional for some countries, but
required for most. It is optional when latitude and longitude
coordinates are provided.
city:
type: string
description: >-
City.
This field is optional only when latitude and longitude
coordinates are provided.
state:
type: string
description: >-
State.
This is not required for most countries, but required in
some (eg: United States).
countryIso2:
type: string
description: >-
Country Code.
This field is optional only when latitude and
longitude coordinates are provided.
addressIdentifier:
maxLength: 20
minLength: 0
type: string
description: Optional identifier for a delivery address.
additionalIdentifiers:
type: array
description: Optional additional identifiers for a delivery address.
items:
$ref: '#/components/schemas/OrderAddressAdditionalIdentifier'
latitude:
type: number
description: >-
Latitude coordinate for the delivery address. Optional, used for
location-based services.
format: double
longitude:
type: number
description: >-
Longitude coordinate for the delivery address. Optional, Used for
location-based services.
format: double
description: Request object for creating orderdeliveryaddress
OrderPostAddress:
type: object
properties:
name:
type: string
description: >-
The first and lastname of the recipient.
Either name or company
is required.
company:
type: string
description: Name of the company.
Either name or company is required.
phone:
type: string
description: Phone number.
email:
type: string
description: E-Mail address.
street:
type: string
description: >-
Street (or Address Line 1).
This field is optional only when
latitude and longitude coordinates are provided.
street2:
type: string
description: Street (or Address Line 2).
This field is optional.
zip:
type: string
description: >-
ZIP Code.
The ZIP code is optional for some countries, but
required for most. It is optional when latitude and longitude
coordinates are provided.
city:
type: string
description: >-
City.
This field is optional only when latitude and longitude
coordinates are provided.
state:
type: string
description: >-
State.
This is not required for most countries, but required in
some (eg: United States).
countryIso2:
type: string
description: >-
Country Code.
This field is optional only when latitude and
longitude coordinates are provided.
description: Request object for creating orderaddress
OrderPostPosition:
required:
- name
- quantity
- sku
type: object
properties:
sku:
type: string
description: The unique identifier of the article that was ordered.
name:
type: string
description: A descriptive name of the article that was ordered.
quantity:
type: integer
description: The quantity that was ordered.
format: int32
price:
type: number
description: >-
The price per piece including taxes.
Required if hasInvoiceData
is set to true.
lot:
type: string
description: >-
Optional value that means a batch, or a specific identified portion
of a batch, having uniform character and quality within specified
limits.
expirationDate:
type: string
description: Optional expiration date.
format: date
location:
type: string
description: Optional storage location.
positionIdentifier:
maxLength: 25
minLength: 0
type: string
description: >-
Optional position identifier which is set from the customer to this
position
productIdentifier:
maxLength: 50
minLength: 0
type: string
description: >-
Optional product identifier which is set from the customer to this
position
customAttributes:
type: object
additionalProperties:
type: string
description: Optional custom attributes for a position.
example: '{"attr1":"val1"}'
description: Request object for creating orderposition
OrderAttachmentPost:
required:
- attachmentPlacement
- copyCount
- printerType
type: object
properties:
filename:
type: string
description: >-
Name for the attachment. This name will be displayed in the
attachments section for the given order
printerType:
type: string
description: >-
Printer type, which should be used for printing the document in the
warehouse
enum:
- LABEL_PRINTER
- DOCUMENT_PRINTER
- DOCUMENT_PRINTER_2_A6
- DOCUMENT_PRINTER_2_FOLIO
attachmentPlacement:
type: string
description: Where the attached document should be placed in regard to the parcel
enum:
- INSIDE_PACKAGE
- OUTSIDE_PACKAGE
copyCount:
minimum: 1
type: integer
description: Number of times the attachment should be printed per shipment
format: int32
printingType:
type: string
description: If the attached document should be printed per order or per shipment
enum:
- ORDER
- SHIPMENT
fileKey:
type: string
description: Identifier of the file to be attached.
mimeType:
type: string
description: Mime type of the file
description: >-
Request payload for attaching a file to an order. Contains file
reference and optional metadata for associating documents with an order.
OrderAddressAdditionalIdentifier:
type: object
properties:
identifier:
type: string
description: The specific identifier string (e.g., a GLN or store ID).
type:
type: string
description: The type of the identifier (e.g., 'GLN', 'SHOP_SPECIFIC').
description: >-
Represents an additional, specialized identifier for an address, such as
a GLN or a shop-specific ID, along with its type.
````