Searches for purchase orders with paging.

get http://localhost:64424/episerverapi/commerce/orders/search/{start}/{maxCount}

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

array of objects

object

OrderNumber

string

An order number used for tracking the order.

AddressId

string

Address ID.

AffiliateId

uuid

Affiliate ID (GUID).

BillingCurrency

string

Billing currency.

CustomerId

uuid

Customer ID (GUID).

CustomerName

string

Customer name.

HandlingTotal

double

Handling total.

InstanceId

uuid

Instance ID (GUID).

MarketId

string

Market ID.

Name

string

required

Order name.

OrderAddresses

array of objects

List of addresses.

OrderAddresses

object

OrderGroupAddressId

int32

Gets the order group address id.

Name

string

Gets or sets the name.

FirstName

string

Gets or sets the first name.

LastName

string

Gets or sets last name.

Organization

string

Gets or sets the organization.

Line1

string

Gets or sets the line1.

Line2

string

Gets or sets the line2.

City

string

Gets or sets the city.

State

string

Gets or sets the state.

CountryCode

string

Gets or sets the country code.

CountryName

string

Gets or sets the name of the country.

PostalCode

string

Gets or sets the postal code.

RegionCode

string

Gets or sets the region code.

RegionName

string

Gets or sets the name of the region.

DaytimePhoneNumber

string

Gets or sets the daytime phone number.

EveningPhoneNumber

string

Gets or sets the evening phone number.

FaxNumber

string

Gets or sets the fax number.

string

Gets or sets the email.

Properties

array of objects

Gets the list of key value pairs for dealing with custom properties.

Properties

object

Key

string

Key of the property.

Value

string

Value of the property.

OrderForms

array of objects

List of order forms.

OrderForms

object

Shipments

array of objects

Gets or sets the shipments.

Shipments

object

DiscountsModel

array of objects

Gets the discounts.

DiscountsModel

object

DiscountId

int32

Gets or sets the discount id.

DiscountAmount

double

Gets or sets the discount amount. Either fixed money value or percentage.

DiscountCode

string

Gets or sets the discount code. Also known as a coupon code.

DiscountName

string

Gets or sets the name of the discount.

DisplayMessage

string

Gets or sets the display message.

DiscountValue

double

Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount
if it is a fixed monetary value. For the percentage based discount this value will be different.

ShipmentId

int32

Gets the shipment id.

ShippingMethodId

uuid

Gets or sets the shipping method id.

ShippingMethodName

string

Gets or sets the name of the shipping method.

ShippingTax

double

Gets or sets the shipment tax.

ShippingAddressId

string

Gets or sets the shipping address name.

ShipmentTrackingNumber

string

Gets or sets the shipment tracking number.

ShippingDiscountAmount

double

Gets or sets the shipping discount amount.

ShippingSubTotal

double

Gets or sets the shipping sub total.

ShippingTotal

double

Gets or sets the total shipping cost, including shipping discounts (if any) and shipping tax.

Status

string

Gets or sets the status.

PrevStatus

string

Gets or sets the previous status.

PickListId

int32

Gets or sets the pick list id.

SubTotal

double

Gets or sets the sub total.

WarehouseCode

string

Gets or sets the warehouse code.

LineItems

array of objects

Gets or sets the collection of line items.

LineItems

object

LineItemId

int32

Gets the identity of the line item.

Code

string

Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content.

DisplayName

string

Gets or sets the display name.

PlacedPrice

double

Gets the price for one item that this line item represent. This property don't take any discounts in consideration.

ExtendedPrice

double

Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.

DiscountedPrice

double

Gets the line item discounted price. Only calculates the price with the "line item discount amount," that is, the discount for a specific item.

Quantity

double

Gets or sets the number of items this line item contains.

ReturnQuantity

double

Gets or sets the returned in stock quantity.

InventoryTrackingStatus

int32

Gets or sets the inventory tracking status on whether to check inventory.

1

IsInventoryAllocated

boolean

Gets or sets a value indicating whether this instance has allocated inventory for the {EPiServer.Commerce.Order.ILineItem.Quantity}.

IsGift

boolean

Gets or sets a value indicating whether the line item is a gift item.

Properties

array of objects

Gets the list of key value pairs for dealing with custom properties.

Properties

object

Key

string

Key of the property.

Value

string

Value of the property.

Properties

array of objects

Gets or sets the list of key value pairs for dealing with custom properties.

Properties

object

Key

string

Key of the property.

Value

string

Value of the property.

LineItems

array of objects

Gets or sets the line items.

LineItems

object

LineItemId

int32

Gets the identity of the line item.

Code

string

Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content.

DisplayName

string

Gets or sets the display name.

PlacedPrice

double

Gets the price for one item that this line item represent. This property don't take any discounts in consideration.

ExtendedPrice

double

Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.

DiscountedPrice

double

Gets the line item discounted price. Only calculates the price with the "line item discount amount," that is, the discount for a specific item.

Quantity

double

Gets or sets the number of items this line item contains.

ReturnQuantity

double

Gets or sets the returned in stock quantity.

InventoryTrackingStatus

int32

Gets or sets the inventory tracking status on whether to check inventory.

1

IsInventoryAllocated

boolean

Gets or sets a value indicating whether this instance has allocated inventory for the {EPiServer.Commerce.Order.ILineItem.Quantity}.

IsGift

boolean

Gets or sets a value indicating whether the line item is a gift item.

Properties

array of objects

Gets the list of key value pairs for dealing with custom properties.

Properties

object

Key

string

Key of the property.

Value

string

Value of the property.

Payments

array of objects

Payments

object

Amount

double

AuthorizationCode

string

BillingAddressId

string

CustomerName

string

ImplementationClass

string

PaymentId

int32

PaymentMethodId

uuid

PaymentMethodName

string

PaymentTypeModel

int32

1 2 3 4 5

Status

string

TransactionType

string

ValidationCode

string

Properties

array of objects

Properties

object

Key

string

Key of the property.

Value

string

Value of the property.

Discounts

array of objects

Gets or sets the discounts.

Discounts

object

DiscountId

int32

Gets or sets the discount id.

DiscountAmount

double

Gets or sets the discount amount. Either fixed money value or percentage.

DiscountCode

string

Gets or sets the discount code. Also known as a coupon code.

DiscountName

string

Gets or sets the name of the discount.

DisplayMessage

string

Gets or sets the display message.

DiscountValue

double

ReturnComment

string

Gets or sets the rma comment.

ReturnType

string

Gets or sets the Return Type. For example can be "Refund", "Exchange" etc.

ReturnAuthCode

string

Gets or sets the RMA auth code. Using for procedure RMA authentications.

OrderFormId

int32

Gets the order form id.

Name

string

Gets or sets the name.

BillingAddressId

string

Gets or sets the billing address id. The id is the name of the address in OrderAddress collection.

ShippingTotal

double

Gets or sets the shipping total, does not includes discounts that have been applied to each shipment.

HandlingTotal

double

Gets or sets the handling total.

TaxTotal

double

Gets or sets the tax total.

DiscountAmount

double

Gets or sets the discount amount. This amount includes shipping discounts as well.

SubTotal

double

Gets or sets the sub total.

Total

double

Gets or sets the total.

Status

string

Gets or sets the status.

RmaNumber

string

Gets or sets the RMA number.

AuthorizedPaymentTotal

double

Gets or sets the authorized payment total.

CapturedPaymentTotal

double

Gets or sets the captured payment total.

Properties

array of objects

Gets the list of key value pairs for dealing with custom properties.

Properties

object

Key

string

Key of the property.

Value

string

Value of the property.

OrderGroupId

int32

Order group ID.

OrderNotes

array of objects

List of order notes.

OrderNotes

object

OrderNoteId

int32

Gets the order note ID.

Created

date-time

Gets Created date.

CustomerId

uuid

Gets or sets note customer ID.

Detail

string

Gets or sets note details.

Title

string

Gets or sets note title.

Type

string

Gets or sets note type.

LineItemId

int32

Gets or sets note related line item ID.

Owner

string

Owner name.

OwnerOrg

string

Owner's organization name.

ProviderId

string

Provider ID.

ShippingTotal

double

Shipping total.

Status

string

Status.
Valid values:

AwaitingExchange
Cancelled
Completed
InProgress
OnHold
PartiallyShipped.

SubTotal

double

Sub-total.

TaxTotal

double

Tax total.

Total

double

Total.

Modified

date-time

Modified date.

Created

date-time

Created date.

Properties

array of objects

Gets the list of key value pairs for dealing with custom properties.

Properties

object

Key

string

Key of the property.

Value

string

Value of the property.

401

If user does not have enough permission for this request.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url http://localhost:64424/episerverapi/commerce/orders/search/start/maxCount \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Searches for purchase orders with paging.

200Return the purchase orders.