Narvar Order API
Create and update orders, including order items, billing, customer, and fulfillment data, to power post-purchase tracking experiences.
OpenAPI Specification
openapi: 3.0.3
info:
title: Narvar
description: Narvar provides connection with Narvar portal. Alows create and update
of orders on narvar portal as well as viewing already created orders.
version: '1.0'
contact:
name: Microsoft Dynamics
url: https://aka.ms/iomsupport
email: [email protected]
servers:
- url: https://api.narvar.com/api/v1
description: Narvar Production API
security:
- basicAuth: []
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
description: Account ID and Auth Tokens for Narvar API authentication
paths:
/orders:
post:
operationId: PostCreateUpdateOrders
summary: Create or Update Orders
description: This will create a new order or send new information about an existing
order
tags: []
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: status
messages:
type: array
items:
type: object
properties:
code:
type: string
description: code
message:
type: string
description: message
description: messages
'304':
description: '304'
content:
application/json:
schema:
type: string
'400':
description: '400'
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: status
messages:
type: array
items:
type: object
properties:
level:
type: string
description: level
code:
type: string
description: code
message:
type: string
description: message
description: messages
'401':
description: '401'
content:
application/json:
schema:
type: string
'403':
description: '403'
content:
application/json:
schema:
type: string
'404':
description: '404'
content:
application/json:
schema:
type: string
'405':
description: '405'
content:
application/json:
schema:
type: string
'409':
description: '409'
content:
application/json:
schema:
type: string
'500':
description: '500'
content:
application/json:
schema:
type: string
'503':
description: '503'
content:
application/json:
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
order_info:
type: object
properties:
order_number:
type: string
description: Order number.Primary identifier
title: order_number
order_date:
type: string
description: Order placement date
title: order_date
order_items:
type: array
items:
type: object
properties:
item_id:
type: string
description: More granular item identifier then SKU
title: item_id
item_image:
type: string
description: Url to a public image
title: item_image
sku:
type: string
description: ID for the item object.Primary Key for OrderItem
title: sku
name:
type: string
description: Item name
title: name
quantity:
type: integer
format: int32
description: Item quantity
title: quantity
item_promise_date:
type: string
description: Shipment promise date
title: item_promise_date
description: order_items
shipments:
type: array
items:
type: object
properties:
items_info:
type: array
items:
type: object
properties:
quantity:
type: integer
format: int32
description: quantity
sku:
type: string
description: sku
item_id:
type: string
description: item_id
description: items_info
carrier:
type: string
description: Normalized carrier moniker
title: carrier
enum:
- ups
- fedex
- usps
- lasership
- ontrac
shipped_to:
type: object
properties:
first_name:
type: string
description: First Name of user receiving shipment
title: first_name
last_name:
type: string
description: Last Name of user receiving shipment
title: last_name
phone:
type: string
description: Phone number of user receiving shipment
title: phone
email:
type: string
description: Email address of user receiving shipment
title: email
address:
type: object
properties:
street_1:
type: string
description: street 1
title: street_1
street_2:
type: string
description: street 2
title: street_2
city:
type: string
description: city
title: city
state:
type: string
description: state
title: state
zip:
type: string
description: zip
title: zip
country:
type: string
description: country
title: country
description: address
description: shipped to
ship_date:
type: string
description: Initial shipment date.
title: ship_date
tracking_number:
type: string
description: Tracking number for the shipment
title: tracking_number
description: shipments
billing:
type: object
properties:
billed_to:
type: object
properties:
first_name:
type: string
description: First Name of billing user
title: first_name
last_name:
type: string
description: Last Name of billing user
title: last_name
phone:
type: string
description: Phone number of billing user
title: phone
phone_extension:
type: string
description: phone extension of billing user
title: phone_extension
email:
type: string
description: Email address of billing user
title: email
address:
type: object
properties:
city:
type: string
description: city
title: city
state:
type: string
description: state
title: state
zip:
type: string
description: zip
title: zip
country:
type: string
description: country
title: country
description: address
description: billed_to
amount:
type: number
format: float
description: Total Billing Amount
title: amount
tax_amount:
type: number
format: float
description: Order Tax Amount
title: tax_amount
description: billing
description: order_info
/orders/{OrderNumber}:
get:
operationId: GetRetrieveOrder
summary: Retrieve Order
description: This operation is used to retrieve order details
tags: []
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
order_info:
type: object
properties:
order_number:
type: string
description: order_number
order_date:
type: string
description: order_date
order_items:
type: array
items:
type: object
properties:
fulfillment_status:
type: string
description: fulfillment_status
item_image:
type: string
description: item_image
item_url:
type: string
description: item_url
name:
type: string
description: name
quantity:
type: integer
format: int32
description: quantity
sku:
type: string
description: sku
unit_price:
type: integer
format: int32
description: unit_price
categories:
type: array
items:
type: string
description: categories
is_backordered:
type: boolean
description: is_backordered
vendors:
type: array
items:
type: object
properties:
phone:
type: string
description: phone
name:
type: string
description: name
address:
type: object
properties:
street_1:
type: string
description: street_1
city:
type: string
description: city
state:
type: string
description: state
zip:
type: string
description: zip
country:
type: string
description: country
street_2:
type: string
description: street_2
description: address
email:
type: string
description: email
type:
type: string
description: type
description: vendors
description:
type: string
description: description
discount_amount:
type: number
format: float
description: discount_amount
discount_percent:
type: number
format: float
description: discount_percent
final_sale_date:
type: string
description: final_sale_date
is_final_sale:
type: boolean
description: is_final_sale
is_gift:
type: boolean
description: is_gift
item_id:
type: string
description: item_id
item_promise_date:
type: string
description: item_promise_date
line_number:
type: integer
format: int32
description: line_number
fulfillment_type:
type: string
description: fulfillment_type
dimensions:
type: object
properties:
uom:
type: string
description: uom
length:
type: number
format: float
description: length
width:
type: number
format: float
description: width
height:
type: number
format: float
description: height
weight:
type: number
format: float
description: weight
weight_uom:
type: string
description: weight_uom
description: dimensions
attributes:
type: object
properties:
ad9:
type: object
properties:
promotion:
type: string
description: promotion
description: ad9
pariaturfb:
type: object
properties:
promotion:
type: string
description: promotion
description: pariaturfb
adipisicing_1c:
type: object
properties:
promotion:
type: string
description: promotion
description: adipisicing_1c
tempor639:
type: object
properties:
promotion:
type: string
description: promotion
description: tempor639
dolor_e:
type: object
properties:
promotion:
type: string
description: promotion
description: dolor_e
consectetur_b:
type: object
properties:
promotion:
type: string
description: promotion
description: consectetur_b
cupidatat8:
type: object
properties:
promotion:
type: string
description: promotion
description: cupidatat8
consequatbc:
type: object
properties:
promotion:
type: string
description: promotion
description: consequatbc
description: attributes
events:
type: array
items:
type: object
properties:
event:
type: string
description: event
quantity:
type: integer
format: int32
description: quantity
sequence:
type: integer
format: int32
description: sequence
date:
type: string
description: date
description: events
anticipated_ship_date:
type: string
description: anticipated_ship_date
original_unit_price:
type: integer
format: int32
description: original_unit_price
original_line_price:
type: integer
format: int32
description: original_line_price
line_price:
type: integer
format: int32
description: line_price
description: order_items
shipments:
type: array
items:
type: object
properties:
items_info:
type: array
items:
type: object
properties:
item_id:
type: string
description: item_id
sku:
type: string
description: sku
quantity:
type: integer
format: int32
description: quantity
description: items_info
carrier:
type: string
description: carrier
ship_date:
type: string
description: ship_date
tracking_number:
type: string
description: tracking_number
shipped_to:
type: object
properties:
first_name:
type: string
description: first_name
last_name:
type: string
description: last_name
address:
type: object
properties:
street_1:
type: string
description: street_1
city:
type: string
description: city
state:
type: string
description: state
zip:
type: string
description: zip
country:
type: string
description: country
street_2:
type: string
description: street_2
description: address
email:
type: string
description: email
phone:
type: string
description: phone
location_id:
type: string
description: location_id
description: shipped_to
ship_method:
type: string
description: ship_method
carrier_service:
type: string
description: carrier_service
ship_source:
type: string
description: ship_source
ship_discount:
type: number
format: float
description: ship_discount
ship_tax:
type: number
format: float
description: ship_tax
ship_total:
type: number
format: float
description: ship_total
shipped_from:
type: object
properties:
company_name:
type: string
description: company_name
email:
type: string
description: email
first_name:
type: string
description: first_name
last_name:
type: string
description: last_name
phone:
type: string
description: phone
address:
type: object
properties:
street_1:
type: string
description: street_1
city:
type: string
description: city
state:
type: string
description: state
zip:
type: string
description: zip
country:
type: string
description: country
street_2:
type: string
description: street_2
description: address
location_id:
type: string
description: location_id
description: shipped_from
attribute:
type: object
properties:
anim_a36:
type: object
properties:
promotion:
type: string
description: promotion
description: anim_a36
sunt_9:
type: object
properties:
promotion:
type: string
description: promotion
description: sunt_9
eu1bd:
type: object
properties:
promotion:
type: string
description: promotion
description: eu1bd
description: attribute
description: shipments
billing:
type: object
properties:
billed_to:
type: object
properties:
first_name:
type: string
description: first_name
last_name:
type: string
description: last_name
address:
type: object
properties:
street_1:
type: string
description: street_1
city:
type: string
description: city
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/narvar/refs/heads/main/openapi/narvar-order-openapi.yml