ESPM Sales Service

Base URL: /sale.svc/api/v1/, Version: 1.0.0

This is an ESPM Sales Service

Default response content-types: application/json
Schemes: http

Summary

Path Operation Description
/salesOrders GET

Get all SalesOrders

POST

Create Sales Order

/salesOrders/email/{emailAddress} GET

Get Sales Order by Id

/salesOrders/{salesOrderId} GET

Get Sales Order by Id

Paths

Get all SalesOrders

GET /salesOrders

Tags: Sales Order

The Sales Order endpoint returns all the Sales Orders in the Webshop.

application/json

200 OK

An array of Sales Orders

default

Unexpected error

Create Sales Order

POST /salesOrders

Tags: Sales Order

"This endpoint is used to create a new Sales Order"

application/json

Details of the sales order which needs to be created.

application/json

201 Created

Sales Order created

503 Service Unavailable

Unable to create sales order

default

Unexpected error

Get Sales Order by Id

GET /salesOrders/email/{emailAddress}

Tags: Sales Order

"The Sales Order endpoint which returns sales orders by customer email."

application/json

emailAddress

Email Address of Customer whose sales orders be fetched

path string

application/json

200 OK

Sales Order with matching Id

404 Not Found

Sales Order not found

default

Unexpected error

Get Sales Order by Id

GET /salesOrders/{salesOrderId}

Tags: Sales Order

"The Sales Order endpoint which returns sales orders by id."

application/json

salesOrderId

ID of Sales Order that needs to be fetched

path string

application/json

200 OK

Sales Order with matching Id

404 Not Found

Sales Order not found

default

Unexpected error

Schema definitions

Error: object

code: integer (int32)
message: string
fields: string

SalesOrder: object

salesOrderId: string (up to 50 chars)

Unique identifier representing a specific customer.

customerEmail: string

Email Address of customer

currencyCode: string (up to 5 chars)

Currency of product price

grossAmount: number (double)

Gross amount of sales order

netAmount: number (double)

Net amount of sales order

taxAmount: number (double)

Tax amount of sales order

lifeCycleStatus: string (up to 1 chars)

Life cycle status of the Sales Order

lifeCycleStatusName: string

Life cycle status name of the Sales Order

createdAt: string

Sales order creation date

deliveryDate: string

Sales order delivery date

productId: string (up to 10 chars)

Unique identifier representing a specific product.

quantity: number (double)

Product quantity.

quantityUnit: string (up to 3 chars)

Unit of Quantity. e.g kg, metre