OrderAPI

All URIs are relative to https://api.api2cart.local.com/v1.1

Method	HTTP request	Description
orderAbandonedList	GET /order.abandoned.list.json	order.abandoned.list
orderAdd	POST /order.add.json	order.add
orderCalculate	POST /order.calculate.json	order.calculate
orderCount	GET /order.count.json	order.count
orderFinancialStatusList	GET /order.financial_status.list.json	order.financial_status.list
orderFulfillmentStatusList	GET /order.fulfillment_status.list.json	order.fulfillment_status.list
orderInfo	GET /order.info.json	order.info
orderList	GET /order.list.json	order.list
orderPreestimateShippingList	POST /order.preestimate_shipping.list.json	order.preestimate_shipping.list
orderRefundAdd	POST /order.refund.add.json	order.refund.add
orderReturnAdd	POST /order.return.add.json	order.return.add
orderReturnDelete	DELETE /order.return.delete.json	order.return.delete
orderReturnUpdate	PUT /order.return.update.json	order.return.update
orderShipmentAdd	POST /order.shipment.add.json	order.shipment.add
orderShipmentAddBatch	POST /order.shipment.add.batch.json	order.shipment.add.batch
orderShipmentDelete	DELETE /order.shipment.delete.json	order.shipment.delete
orderShipmentEventAdd	POST /order.shipment.event.add.json	order.shipment.event.add
orderShipmentEventList	GET /order.shipment.event.list.json	order.shipment.event.list
orderShipmentInfo	GET /order.shipment.info.json	order.shipment.info
orderShipmentList	GET /order.shipment.list.json	order.shipment.list
orderShipmentTrackingAdd	POST /order.shipment.tracking.add.json	order.shipment.tracking.add
orderShipmentUpdate	PUT /order.shipment.update.json	order.shipment.update
orderStatusList	GET /order.status.list.json	order.status.list
orderTransactionList	GET /order.transaction.list.json	order.transaction.list
orderUpdate	PUT /order.update.json	order.update

orderAbandonedList

    open class func orderAbandonedList(start: Int? = nil, count: Int? = nil, pageCursor: String? = nil, customerId: String? = nil, customerEmail: String? = nil, storeId: String? = nil, createdFrom: String? = nil, createdTo: String? = nil, modifiedFrom: String? = nil, modifiedTo: String? = nil, skipEmptyEmail: Bool? = nil, roundingPrecision: Int? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: ModelResponseOrderAbandonedList?, _ error: Error?) -> Void)

order.abandoned.list

Get list of orders that were left by customers before completing the order.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let start = 987 // Int | This parameter sets the number from which you want to get entities (optional) (default to 0)
let count = 987 // Int | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 (optional) (default to 10)
let pageCursor = "" // String | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) (optional)
let customerId = "customerId_example" // String | Retrieves orders specified by customer id (optional)
let customerEmail = "customerEmail_example" // String | Retrieves orders specified by customer email (optional)
let storeId = "storeId_example" // String | Store Id (optional)
let createdFrom = "createdFrom_example" // String | Retrieve entities from their creation date (optional)
let createdTo = "createdTo_example" // String | Retrieve entities to their creation date (optional)
let modifiedFrom = "modifiedFrom_example" // String | Retrieve entities from their modification date (optional)
let modifiedTo = "modifiedTo_example" // String | Retrieve entities to their modification date (optional)
let skipEmptyEmail = true // Bool | Filter empty emails (optional) (default to false)
let roundingPrecision = 987 // Int | <p>Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).</p> <p>Supported values range from <b>1</b> to <b>6</b>.</p> <p>The default rounding precision may vary depending on the platform. You can retrieve the default value using the <strong>cart.info</strong> method in the <code>default_rounding_precision</code> field. </p><p>Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.</p> (optional)
let responseFields = "responseFields_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional)
let params = "params_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional) (default to "customer,totals,items")
let exclude = "exclude_example" // String | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional)

// order.abandoned.list
OrderAPI.orderAbandonedList(start: start, count: count, pageCursor: pageCursor, customerId: customerId, customerEmail: customerEmail, storeId: storeId, createdFrom: createdFrom, createdTo: createdTo, modifiedFrom: modifiedFrom, modifiedTo: modifiedTo, skipEmptyEmail: skipEmptyEmail, roundingPrecision: roundingPrecision, responseFields: responseFields, params: params, exclude: exclude) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
start	Int	This parameter sets the number from which you want to get entities	[optional] [default to 0]
count	Int	This parameter sets the entity amount that has to be retrieved. Max allowed count=250	[optional] [default to 10]
pageCursor	String	Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)	[optional]
customerId	String	Retrieves orders specified by customer id	[optional]
customerEmail	String	Retrieves orders specified by customer email	[optional]
storeId	String	Store Id	[optional]
createdFrom	String	Retrieve entities from their creation date	[optional]
createdTo	String	Retrieve entities to their creation date	[optional]
modifiedFrom	String	Retrieve entities from their modification date	[optional]
modifiedTo	String	Retrieve entities to their modification date	[optional]
skipEmptyEmail	Bool	Filter empty emails	[optional] [default to false]
roundingPrecision	Int	<p>Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).</p> <p>Supported values range from <b>1</b> to <b>6</b>.</p> <p>The default rounding precision may vary depending on the platform. You can retrieve the default value using the <strong>cart.info</strong> method in the <code>default_rounding_precision</code> field. </p><p>Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.</p>	[optional]
responseFields	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
params	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to "customer,totals,items"]
exclude	String	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]

Return type

ModelResponseOrderAbandonedList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderAdd

    open class func orderAdd(orderAdd: OrderAdd, completion: @escaping (_ data: OrderAdd200Response?, _ error: Error?) -> Void)

order.add

Add a new order to the cart.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderAdd = OrderAdd(id: "id_example", orderId: "orderId_example", storeId: "storeId_example", channelId: "channelId_example", orderStatus: "orderStatus_example", fulfillmentStatus: "fulfillmentStatus_example", financialStatus: "financialStatus_example", customerEmail: "customerEmail_example", customerFirstName: "customerFirstName_example", customerLastName: "customerLastName_example", customerPhone: "customerPhone_example", customerCountry: "customerCountry_example", customerBirthday: "customerBirthday_example", customerFax: "customerFax_example", isGuest: true, orderPaymentMethod: "orderPaymentMethod_example", transactionId: "transactionId_example", currency: "currency_example", date: "date_example", dateModified: "dateModified_example", dateFinished: "dateFinished_example", billFirstName: "billFirstName_example", billLastName: "billLastName_example", billAddress1: "billAddress1_example", billAddress2: "billAddress2_example", billCity: "billCity_example", billPostcode: "billPostcode_example", billState: "billState_example", billCountry: "billCountry_example", billCompany: "billCompany_example", billPhone: "billPhone_example", billFax: "billFax_example", shippFirstName: "shippFirstName_example", shippLastName: "shippLastName_example", shippAddress1: "shippAddress1_example", shippAddress2: "shippAddress2_example", shippCity: "shippCity_example", shippPostcode: "shippPostcode_example", shippState: "shippState_example", shippCountry: "shippCountry_example", shippCompany: "shippCompany_example", shippPhone: "shippPhone_example", shippFax: "shippFax_example", subtotalPrice: 123, taxPrice: 123, totalPrice: 123, totalPaid: 123, totalWeight: 123, pricesIncTax: true, shippingPrice: 123, shippingTax: 123, discount: 123, couponDiscount: 123, giftCertificateDiscount: 123, orderShippingMethod: "orderShippingMethod_example", carrierId: "carrierId_example", warehouseId: "warehouseId_example", coupons: ["coupons_example"], tags: "tags_example", comment: "comment_example", adminComment: "adminComment_example", adminPrivateComment: "adminPrivateComment_example", sendNotifications: true, sendAdminNotifications: true, externalSource: "externalSource_example", inventoryBehaviour: "inventoryBehaviour_example", createInvoice: true, invoiceAdminComment: "invoiceAdminComment_example", noteAttributes: [OrderAdd_note_attributes_inner(name: "name_example", value: "value_example")], clearCache: false, origin: "origin_example", feePrice: 123, idempotencyKey: "idempotencyKey_example", orderItem: [OrderAdd_order_item_inner(orderItemId: "orderItemId_example", orderItemName: "orderItemName_example", orderItemModel: "orderItemModel_example", orderItemPrice: 123, orderItemQuantity: 123, orderItemWeight: 123, orderItemVariantId: "orderItemVariantId_example", orderItemTax: 123, orderItemTaxClass: "orderItemTaxClass_example", orderItemPriceIncludesTax: false, orderItemParent: 123, orderItemParentOptionName: "orderItemParentOptionName_example", orderItemAllowRefundItemsSeparately: true, orderItemAllowShipItemsSeparately: true, orderItemOption: [OrderAdd_order_item_inner_order_item_option_inner(orderItemOptionName: "orderItemOptionName_example", orderItemOptionValue: "orderItemOptionValue_example", orderItemOptionPrice: 123)], orderItemProperty: [OrderAdd_order_item_inner_order_item_property_inner(orderItemPropertyName: "orderItemPropertyName_example", orderItemPropertyValue: "orderItemPropertyValue_example")])]) // OrderAdd | 

// order.add
OrderAPI.orderAdd(orderAdd: orderAdd) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderAdd	OrderAdd

Return type

OrderAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderCalculate

    open class func orderCalculate(orderCalculate: OrderCalculate, completion: @escaping (_ data: OrderCalculate200Response?, _ error: Error?) -> Void)

order.calculate

Calculates the total cost of an order for a given customer and a set of products, as well as the available shipping methods based on the specified address. The calculation takes into account store product prices, discounts, taxes, shipping costs, and other store settings. The result includes a detailed breakdown of the final order cost by its components.

Note that the final totals, taxes, and other amounts must include the corresponding values for the selected shipping method.

The result of this method can be used when creating an order using the order.add method.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderCalculate = OrderCalculate(customerEmail: "customerEmail_example", currency: "currency_example", currencyId: "currencyId_example", storeId: "storeId_example", coupons: ["coupons_example"], roundingPrecision: 123, shippFirstName: "shippFirstName_example", shippLastName: "shippLastName_example", shippAddress1: "shippAddress1_example", shippAddress2: "shippAddress2_example", shippCity: "shippCity_example", shippPostcode: "shippPostcode_example", shippState: "shippState_example", shippCountry: "shippCountry_example", shippCompany: "shippCompany_example", shippPhone: "shippPhone_example", billFirstName: "billFirstName_example", billLastName: "billLastName_example", billAddress1: "billAddress1_example", billAddress2: "billAddress2_example", billCity: "billCity_example", billPostcode: "billPostcode_example", billState: "billState_example", billCountry: "billCountry_example", billCompany: "billCompany_example", billPhone: "billPhone_example", responseFields: "responseFields_example", idempotencyKey: "idempotencyKey_example", orderItem: [OrderCalculate_order_item_inner(orderItemId: "orderItemId_example", orderItemQuantity: 123, orderItemVariantId: "orderItemVariantId_example", orderItemParent: 123, orderItemParentOptionName: "orderItemParentOptionName_example", orderItemOption: [OrderCalculate_order_item_inner_order_item_option_inner(orderItemOptionName: "orderItemOptionName_example", orderItemOptionValue: "orderItemOptionValue_example")])]) // OrderCalculate | 

// order.calculate
OrderAPI.orderCalculate(orderCalculate: orderCalculate) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderCalculate	OrderCalculate

Return type

OrderCalculate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderCount

    open class func orderCount(orderIds: String? = nil, ids: String? = nil, customerId: String? = nil, storeId: String? = nil, customerEmail: String? = nil, orderStatus: String? = nil, orderStatusIds: [String]? = nil, ebayOrderStatus: String? = nil, financialStatus: String? = nil, financialStatusIds: [String]? = nil, fulfillmentChannel: String? = nil, fulfillmentStatus: String? = nil, shippingMethod: String? = nil, deliveryMethod: String? = nil, tags: String? = nil, shipNodeType: String? = nil, createdFrom: String? = nil, createdTo: String? = nil, modifiedFrom: String? = nil, modifiedTo: String? = nil, useLatestApiVersion: Bool? = nil, vendorId: String? = nil, completion: @escaping (_ data: OrderCount200Response?, _ error: Error?) -> Void)

order.count

Count orders in store

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderIds = "orderIds_example" // String | Counts orders specified by order ids (optional)
let ids = "ids_example" // String | Counts orders specified by ids (optional)
let customerId = "customerId_example" // String | Counts orders quantity specified by customer id (optional)
let storeId = "storeId_example" // String | Counts orders quantity specified by store id (optional)
let customerEmail = "customerEmail_example" // String | Counts orders quantity specified by customer email (optional)
let orderStatus = "orderStatus_example" // String | Counts orders quantity specified by order status (optional)
let orderStatusIds = ["inner_example"] // [String] | Retrieves orders specified by order statuses (optional)
let ebayOrderStatus = "ebayOrderStatus_example" // String | Counts orders quantity specified by order status (optional)
let financialStatus = "financialStatus_example" // String | Counts orders quantity specified by financial status (optional)
let financialStatusIds = ["inner_example"] // [String] | Retrieves orders count specified by financial status ids (optional)
let fulfillmentChannel = "fulfillmentChannel_example" // String | Retrieves order with a fulfillment channel (optional)
let fulfillmentStatus = "fulfillmentStatus_example" // String | Create order with fulfillment status (optional)
let shippingMethod = "shippingMethod_example" // String | Retrieve entities according to shipping method (optional)
let deliveryMethod = "deliveryMethod_example" // String | Retrieves order with delivery method (optional)
let tags = "tags_example" // String | Order tags (optional)
let shipNodeType = "shipNodeType_example" // String | Retrieves order with ship node type (optional)
let createdFrom = "createdFrom_example" // String | Retrieve entities from their creation date (optional)
let createdTo = "createdTo_example" // String | Retrieve entities to their creation date (optional)
let modifiedFrom = "modifiedFrom_example" // String | Retrieve entities from their modification date (optional)
let modifiedTo = "modifiedTo_example" // String | Retrieve entities to their modification date (optional)
let useLatestApiVersion = true // Bool | Use the latest platform API version (optional) (default to false)
let vendorId = "vendorId_example" // String | Counts orders specified by vendor id (optional)

// order.count
OrderAPI.orderCount(orderIds: orderIds, ids: ids, customerId: customerId, storeId: storeId, customerEmail: customerEmail, orderStatus: orderStatus, orderStatusIds: orderStatusIds, ebayOrderStatus: ebayOrderStatus, financialStatus: financialStatus, financialStatusIds: financialStatusIds, fulfillmentChannel: fulfillmentChannel, fulfillmentStatus: fulfillmentStatus, shippingMethod: shippingMethod, deliveryMethod: deliveryMethod, tags: tags, shipNodeType: shipNodeType, createdFrom: createdFrom, createdTo: createdTo, modifiedFrom: modifiedFrom, modifiedTo: modifiedTo, useLatestApiVersion: useLatestApiVersion, vendorId: vendorId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderIds	String	Counts orders specified by order ids	[optional]
ids	String	Counts orders specified by ids	[optional]
customerId	String	Counts orders quantity specified by customer id	[optional]
storeId	String	Counts orders quantity specified by store id	[optional]
customerEmail	String	Counts orders quantity specified by customer email	[optional]
orderStatus	String	Counts orders quantity specified by order status	[optional]
orderStatusIds	[String]	Retrieves orders specified by order statuses	[optional]
ebayOrderStatus	String	Counts orders quantity specified by order status	[optional]
financialStatus	String	Counts orders quantity specified by financial status	[optional]
financialStatusIds	[String]	Retrieves orders count specified by financial status ids	[optional]
fulfillmentChannel	String	Retrieves order with a fulfillment channel	[optional]
fulfillmentStatus	String	Create order with fulfillment status	[optional]
shippingMethod	String	Retrieve entities according to shipping method	[optional]
deliveryMethod	String	Retrieves order with delivery method	[optional]
tags	String	Order tags	[optional]
shipNodeType	String	Retrieves order with ship node type	[optional]
createdFrom	String	Retrieve entities from their creation date	[optional]
createdTo	String	Retrieve entities to their creation date	[optional]
modifiedFrom	String	Retrieve entities from their modification date	[optional]
modifiedTo	String	Retrieve entities to their modification date	[optional]
useLatestApiVersion	Bool	Use the latest platform API version	[optional] [default to false]
vendorId	String	Counts orders specified by vendor id	[optional]

Return type

OrderCount200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderFinancialStatusList

    open class func orderFinancialStatusList(completion: @escaping (_ data: OrderFinancialStatusList200Response?, _ error: Error?) -> Void)

order.financial_status.list

Retrieve list of financial statuses

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient


// order.financial_status.list
OrderAPI.orderFinancialStatusList() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

OrderFinancialStatusList200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderFulfillmentStatusList

    open class func orderFulfillmentStatusList(action: String? = nil, completion: @escaping (_ data: OrderFulfillmentStatusList200Response?, _ error: Error?) -> Void)

order.fulfillment_status.list

Retrieve list of fulfillment statuses

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let action = "action_example" // String | Available statuses for the specified action. (optional)

// order.fulfillment_status.list
OrderAPI.orderFulfillmentStatusList(action: action) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
action	String	Available statuses for the specified action.	[optional]

Return type

OrderFulfillmentStatusList200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderInfo

    open class func orderInfo(id: String? = nil, orderId: String? = nil, storeId: String? = nil, params: String? = nil, responseFields: String? = nil, exclude: String? = nil, enableCache: Bool? = nil, useLatestApiVersion: Bool? = nil, roundingPrecision: Int? = nil, allowUserDefinedOrderStatuses: Bool? = nil, completion: @escaping (_ data: OrderInfo200Response?, _ error: Error?) -> Void)

order.info

Info about a specific order by ID

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let id = "id_example" // String | Retrieves order info specified by id (optional)
let orderId = "orderId_example" // String | Retrieves order’s info specified by order id (optional)
let storeId = "storeId_example" // String | Defines store id where the order should be found (optional)
let params = "params_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional) (default to "order_id,customer,totals,address,items,bundles,status")
let responseFields = "responseFields_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional)
let exclude = "exclude_example" // String | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional)
let enableCache = true // Bool | If the value is 'true' and order exist in our cache, we will return order.info response from cache (optional) (default to false)
let useLatestApiVersion = true // Bool | Use the latest platform API version (optional) (default to false)
let roundingPrecision = 987 // Int | <p>Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).</p> <p>Supported values range from <b>1</b> to <b>6</b>.</p> <p>The default rounding precision may vary depending on the platform. You can retrieve the default value using the <strong>cart.info</strong> method in the <code>default_rounding_precision</code> field. </p><p>Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.</p> (optional)
let allowUserDefinedOrderStatuses = true // Bool | Indicates whether custom (user-defined) order statuses should be included in the response. (optional) (default to false)

// order.info
OrderAPI.orderInfo(id: id, orderId: orderId, storeId: storeId, params: params, responseFields: responseFields, exclude: exclude, enableCache: enableCache, useLatestApiVersion: useLatestApiVersion, roundingPrecision: roundingPrecision, allowUserDefinedOrderStatuses: allowUserDefinedOrderStatuses) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	Retrieves order info specified by id	[optional]
orderId	String	Retrieves order’s info specified by order id	[optional]
storeId	String	Defines store id where the order should be found	[optional]
params	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to "order_id,customer,totals,address,items,bundles,status"]
responseFields	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
exclude	String	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]
enableCache	Bool	If the value is 'true' and order exist in our cache, we will return order.info response from cache	[optional] [default to false]
useLatestApiVersion	Bool	Use the latest platform API version	[optional] [default to false]
roundingPrecision	Int	<p>Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).</p> <p>Supported values range from <b>1</b> to <b>6</b>.</p> <p>The default rounding precision may vary depending on the platform. You can retrieve the default value using the <strong>cart.info</strong> method in the <code>default_rounding_precision</code> field. </p><p>Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.</p>	[optional]
allowUserDefinedOrderStatuses	Bool	Indicates whether custom (user-defined) order statuses should be included in the response.	[optional] [default to false]

Return type

OrderInfo200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderList

    open class func orderList(start: Int? = nil, count: Int? = nil, pageCursor: String? = nil, ids: String? = nil, orderIds: String? = nil, sinceId: String? = nil, storeId: String? = nil, vendorId: String? = nil, customerId: String? = nil, customerEmail: String? = nil, basketId: String? = nil, currencyId: String? = nil, phone: String? = nil, orderStatus: String? = nil, orderStatusIds: [String]? = nil, ebayOrderStatus: String? = nil, financialStatus: String? = nil, financialStatusIds: [String]? = nil, fulfillmentStatus: String? = nil, returnStatus: String? = nil, fulfillmentChannel: String? = nil, shippingMethod: String? = nil, skipOrderIds: String? = nil, isDeleted: Bool? = nil, shippingCountryIso3: String? = nil, deliveryMethod: String? = nil, shipNodeType: String? = nil, createdTo: String? = nil, createdFrom: String? = nil, modifiedTo: String? = nil, modifiedFrom: String? = nil, tags: String? = nil, sortBy: String? = nil, sortDirection: String? = nil, params: String? = nil, responseFields: String? = nil, exclude: String? = nil, enableCache: Bool? = nil, useLatestApiVersion: Bool? = nil, roundingPrecision: Int? = nil, allowUserDefinedOrderStatuses: Bool? = nil, completion: @escaping (_ data: ModelResponseOrderList?, _ error: Error?) -> Void)

order.list

Get list of orders from store.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let start = 987 // Int | This parameter sets the number from which you want to get entities (optional) (default to 0)
let count = 987 // Int | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 (optional) (default to 10)
let pageCursor = "" // String | Used to retrieve orders via cursor-based pagination (it can't be used with any other filtering parameter) (optional)
let ids = "ids_example" // String | Retrieves orders specified by ids (optional)
let orderIds = "orderIds_example" // String | Retrieves orders specified by order ids (optional)
let sinceId = "sinceId_example" // String | Retrieve entities starting from the specified id. (optional)
let storeId = "storeId_example" // String | Store Id (optional)
let vendorId = "vendorId_example" // String | Retrieves orders specified by vendor id (optional)
let customerId = "customerId_example" // String | Retrieves orders specified by customer id (optional)
let customerEmail = "customerEmail_example" // String | Retrieves orders specified by customer email (optional)
let basketId = "basketId_example" // String | Retrieves order’s info specified by basket id. (optional)
let currencyId = "currencyId_example" // String | Currency Id (optional)
let phone = "phone_example" // String | Filter orders by customer's phone number (optional)
let orderStatus = "orderStatus_example" // String | Retrieves orders specified by order status (optional)
let orderStatusIds = ["inner_example"] // [String] | Retrieves orders specified by order statuses (optional)
let ebayOrderStatus = "ebayOrderStatus_example" // String | Retrieves orders specified by order status (optional)
let financialStatus = "financialStatus_example" // String | Retrieves orders specified by financial status (optional)
let financialStatusIds = ["inner_example"] // [String] | Retrieves orders specified by financial status ids (optional)
let fulfillmentStatus = "fulfillmentStatus_example" // String | Create order with fulfillment status (optional)
let returnStatus = "returnStatus_example" // String | Retrieves orders specified by return status (optional)
let fulfillmentChannel = "fulfillmentChannel_example" // String | Retrieves order with a fulfillment channel (optional)
let shippingMethod = "shippingMethod_example" // String | Retrieve entities according to shipping method (optional)
let skipOrderIds = "skipOrderIds_example" // String | Skipped orders by ids (optional)
let isDeleted = true // Bool | Filter deleted orders (optional)
let shippingCountryIso3 = "shippingCountryIso3_example" // String | Retrieve entities according to shipping country (optional)
let deliveryMethod = "deliveryMethod_example" // String | Retrieves order with delivery method (optional)
let shipNodeType = "shipNodeType_example" // String | Retrieves order with ship node type (optional)
let createdTo = "createdTo_example" // String | Retrieve entities to their creation date (optional)
let createdFrom = "createdFrom_example" // String | Retrieve entities from their creation date (optional)
let modifiedTo = "modifiedTo_example" // String | Retrieve entities to their modification date (optional)
let modifiedFrom = "modifiedFrom_example" // String | Retrieve entities from their modification date (optional)
let tags = "tags_example" // String | Order tags (optional)
let sortBy = "sortBy_example" // String | Set field to sort by (optional) (default to "order_id")
let sortDirection = "sortDirection_example" // String | Set sorting direction (optional) (default to "asc")
let params = "params_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional) (default to "order_id,customer,totals,address,items,bundles,status")
let responseFields = "responseFields_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional)
let exclude = "exclude_example" // String | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional)
let enableCache = true // Bool | If the value is 'true', we will cache orders for a 15 minutes in order to increase speed and reduce requests throttling for some methods and shoping platforms (for example order.shipment.add) (optional) (default to false)
let useLatestApiVersion = true // Bool | Use the latest platform API version (optional) (default to false)
let roundingPrecision = 987 // Int | <p>Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).</p> <p>Supported values range from <b>1</b> to <b>6</b>.</p> <p>The default rounding precision may vary depending on the platform. You can retrieve the default value using the <strong>cart.info</strong> method in the <code>default_rounding_precision</code> field. </p><p>Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.</p> (optional)
let allowUserDefinedOrderStatuses = true // Bool | Indicates whether custom (user-defined) order statuses should be included in the response. (optional) (default to false)

// order.list
OrderAPI.orderList(start: start, count: count, pageCursor: pageCursor, ids: ids, orderIds: orderIds, sinceId: sinceId, storeId: storeId, vendorId: vendorId, customerId: customerId, customerEmail: customerEmail, basketId: basketId, currencyId: currencyId, phone: phone, orderStatus: orderStatus, orderStatusIds: orderStatusIds, ebayOrderStatus: ebayOrderStatus, financialStatus: financialStatus, financialStatusIds: financialStatusIds, fulfillmentStatus: fulfillmentStatus, returnStatus: returnStatus, fulfillmentChannel: fulfillmentChannel, shippingMethod: shippingMethod, skipOrderIds: skipOrderIds, isDeleted: isDeleted, shippingCountryIso3: shippingCountryIso3, deliveryMethod: deliveryMethod, shipNodeType: shipNodeType, createdTo: createdTo, createdFrom: createdFrom, modifiedTo: modifiedTo, modifiedFrom: modifiedFrom, tags: tags, sortBy: sortBy, sortDirection: sortDirection, params: params, responseFields: responseFields, exclude: exclude, enableCache: enableCache, useLatestApiVersion: useLatestApiVersion, roundingPrecision: roundingPrecision, allowUserDefinedOrderStatuses: allowUserDefinedOrderStatuses) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
start	Int	This parameter sets the number from which you want to get entities	[optional] [default to 0]
count	Int	This parameter sets the entity amount that has to be retrieved. Max allowed count=250	[optional] [default to 10]
pageCursor	String	Used to retrieve orders via cursor-based pagination (it can't be used with any other filtering parameter)	[optional]
ids	String	Retrieves orders specified by ids	[optional]
orderIds	String	Retrieves orders specified by order ids	[optional]
sinceId	String	Retrieve entities starting from the specified id.	[optional]
storeId	String	Store Id	[optional]
vendorId	String	Retrieves orders specified by vendor id	[optional]
customerId	String	Retrieves orders specified by customer id	[optional]
customerEmail	String	Retrieves orders specified by customer email	[optional]
basketId	String	Retrieves order’s info specified by basket id.	[optional]
currencyId	String	Currency Id	[optional]
phone	String	Filter orders by customer's phone number	[optional]
orderStatus	String	Retrieves orders specified by order status	[optional]
orderStatusIds	[String]	Retrieves orders specified by order statuses	[optional]
ebayOrderStatus	String	Retrieves orders specified by order status	[optional]
financialStatus	String	Retrieves orders specified by financial status	[optional]
financialStatusIds	[String]	Retrieves orders specified by financial status ids	[optional]
fulfillmentStatus	String	Create order with fulfillment status	[optional]
returnStatus	String	Retrieves orders specified by return status	[optional]
fulfillmentChannel	String	Retrieves order with a fulfillment channel	[optional]
shippingMethod	String	Retrieve entities according to shipping method	[optional]
skipOrderIds	String	Skipped orders by ids	[optional]
isDeleted	Bool	Filter deleted orders	[optional]
shippingCountryIso3	String	Retrieve entities according to shipping country	[optional]
deliveryMethod	String	Retrieves order with delivery method	[optional]
shipNodeType	String	Retrieves order with ship node type	[optional]
createdTo	String	Retrieve entities to their creation date	[optional]
createdFrom	String	Retrieve entities from their creation date	[optional]
modifiedTo	String	Retrieve entities to their modification date	[optional]
modifiedFrom	String	Retrieve entities from their modification date	[optional]
tags	String	Order tags	[optional]
sortBy	String	Set field to sort by	[optional] [default to "order_id"]
sortDirection	String	Set sorting direction	[optional] [default to "asc"]
params	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to "order_id,customer,totals,address,items,bundles,status"]
responseFields	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
exclude	String	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]
enableCache	Bool	If the value is 'true', we will cache orders for a 15 minutes in order to increase speed and reduce requests throttling for some methods and shoping platforms (for example order.shipment.add)	[optional] [default to false]
useLatestApiVersion	Bool	Use the latest platform API version	[optional] [default to false]
roundingPrecision	Int	<p>Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).</p> <p>Supported values range from <b>1</b> to <b>6</b>.</p> <p>The default rounding precision may vary depending on the platform. You can retrieve the default value using the <strong>cart.info</strong> method in the <code>default_rounding_precision</code> field. </p><p>Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.</p>	[optional]
allowUserDefinedOrderStatuses	Bool	Indicates whether custom (user-defined) order statuses should be included in the response.	[optional] [default to false]

Return type

ModelResponseOrderList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderPreestimateShippingList

    open class func orderPreestimateShippingList(orderPreestimateShippingList: OrderPreestimateShippingList, completion: @escaping (_ data: ModelResponseOrderPreestimateShippingList?, _ error: Error?) -> Void)

order.preestimate_shipping.list

Retrieve list of order preestimated shipping methods

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderPreestimateShippingList = OrderPreestimateShippingList(warehouseId: "warehouseId_example", customerId: "customerId_example", customerEmail: "customerEmail_example", storeId: "storeId_example", shippAddress1: "shippAddress1_example", shippCity: "shippCity_example", shippPostcode: "shippPostcode_example", shippState: "shippState_example", shippCountry: "shippCountry_example", params: "params_example", exclude: "exclude_example", idempotencyKey: "idempotencyKey_example", orderItem: [OrderPreestimateShippingList_order_item_inner(orderItemId: "orderItemId_example", orderItemModel: "orderItemModel_example", orderItemQuantity: 123, orderItemWeight: 123, orderItemVariantId: "orderItemVariantId_example", orderItemOption: [OrderPreestimateShippingList_order_item_inner_order_item_option_inner(orderItemOptionName: "orderItemOptionName_example", orderItemOptionId: "orderItemOptionId_example", orderItemOptionValue: "orderItemOptionValue_example", orderItemOptionValueId: "orderItemOptionValueId_example", orderItemOptionUsedInCombinations: false)])]) // OrderPreestimateShippingList | 

// order.preestimate_shipping.list
OrderAPI.orderPreestimateShippingList(orderPreestimateShippingList: orderPreestimateShippingList) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderPreestimateShippingList	OrderPreestimateShippingList

Return type

ModelResponseOrderPreestimateShippingList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderRefundAdd

    open class func orderRefundAdd(orderRefundAdd: OrderRefundAdd, completion: @escaping (_ data: OrderRefundAdd200Response?, _ error: Error?) -> Void)

order.refund.add

Add a refund to the order.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderRefundAdd = OrderRefundAdd(orderId: "orderId_example", items: [OrderRefundAdd_items_inner(orderProductId: "orderProductId_example", quantity: 123, price: 123)], totalPrice: 123, shippingPrice: 123, feePrice: 123, message: "message_example", itemRestock: true, sendNotifications: true, date: "date_example", storeId: "storeId_example", isOnline: false, idempotencyKey: "idempotencyKey_example") // OrderRefundAdd | 

// order.refund.add
OrderAPI.orderRefundAdd(orderRefundAdd: orderRefundAdd) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderRefundAdd	OrderRefundAdd

Return type

OrderRefundAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderReturnAdd

    open class func orderReturnAdd(orderReturnAdd: OrderReturnAdd, completion: @escaping (_ data: OrderReturnAdd200Response?, _ error: Error?) -> Void)

order.return.add

Create new return request.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderReturnAdd = OrderReturnAdd(orderId: "orderId_example", storeId: "storeId_example", returnStatusId: "returnStatusId_example", returnActionId: "returnActionId_example", returnReasonId: "returnReasonId_example", returnAction: "returnAction_example", returnReason: "returnReason_example", itemRestock: true, staffNote: "staffNote_example", comment: "comment_example", message: "message_example", sendNotifications: true, rejectReason: "rejectReason_example", isOnline: false, feePrice: 123, shippingPrice: 123, idempotencyKey: "idempotencyKey_example", orderProducts: [OrderReturnAdd_order_products_inner(orderProductId: "orderProductId_example", orderProductQuantity: 123, orderProductReasonId: "orderProductReasonId_example", orderProductActionId: "orderProductActionId_example", orderProductCustomerComment: "orderProductCustomerComment_example", orderProductHandlingStatus: "orderProductHandlingStatus_example", orderProductCondition: "orderProductCondition_example", orderProductReason: "orderProductReason_example", orderProductStatus: "orderProductStatus_example")]) // OrderReturnAdd | 

// order.return.add
OrderAPI.orderReturnAdd(orderReturnAdd: orderReturnAdd) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderReturnAdd	OrderReturnAdd

Return type

OrderReturnAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderReturnDelete

    open class func orderReturnDelete(returnId: String, orderId: String, storeId: String? = nil, completion: @escaping (_ data: AttributeValueDelete200Response?, _ error: Error?) -> Void)

order.return.delete

Delete return.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let returnId = "returnId_example" // String | Return ID
let orderId = "orderId_example" // String | Defines the order id
let storeId = "storeId_example" // String | Store Id (optional)

// order.return.delete
OrderAPI.orderReturnDelete(returnId: returnId, orderId: orderId, storeId: storeId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
returnId	String	Return ID
orderId	String	Defines the order id
storeId	String	Store Id	[optional]

Return type

AttributeValueDelete200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderReturnUpdate

    open class func orderReturnUpdate(orderReturnUpdate: OrderReturnUpdate, completion: @escaping (_ data: AccountConfigUpdate200Response?, _ error: Error?) -> Void)

order.return.update

Update order's shipment information.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderReturnUpdate = OrderReturnUpdate(returnId: "returnId_example", orderId: "orderId_example", storeId: "storeId_example", itemRestock: true, returnStatusId: "returnStatusId_example", returnReasonId: "returnReasonId_example", returnActionId: "returnActionId_example", staffNote: "staffNote_example", comment: "comment_example", message: "message_example", sendNotifications: true, rejectReason: "rejectReason_example", returnAction: "returnAction_example", returnReason: "returnReason_example", isOnline: false, feePrice: 123, shippingPrice: 123, idempotencyKey: "idempotencyKey_example", orderProducts: [OrderReturnUpdate_order_products_inner(orderProductId: "orderProductId_example", orderProductQuantity: 123, orderProductStatus: "orderProductStatus_example", orderProductActionId: "orderProductActionId_example")]) // OrderReturnUpdate | 

// order.return.update
OrderAPI.orderReturnUpdate(orderReturnUpdate: orderReturnUpdate) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderReturnUpdate	OrderReturnUpdate

Return type

AccountConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderShipmentAdd

    open class func orderShipmentAdd(orderShipmentAdd: OrderShipmentAdd, completion: @escaping (_ data: OrderShipmentAdd200Response?, _ error: Error?) -> Void)

order.shipment.add

Add a shipment to the order.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderShipmentAdd = OrderShipmentAdd(orderId: "orderId_example", warehouseId: "warehouseId_example", storeId: "storeId_example", shipmentProvider: "shipmentProvider_example", shippingMethod: "shippingMethod_example", items: [OrderShipmentAdd_items_inner(orderProductId: "orderProductId_example", quantity: 123)], trackingNumbers: [OrderShipmentAdd_tracking_numbers_inner(carrierId: "carrierId_example", trackingNumber: "trackingNumber_example")], trackingLink: "trackingLink_example", isShipped: true, sendNotifications: true, adjustStock: true, enableCache: true, checkProcessStatus: false, trackingProvider: "trackingProvider_example", useLatestApiVersion: true, adminComment: "adminComment_example", idempotencyKey: "idempotencyKey_example") // OrderShipmentAdd | 

// order.shipment.add
OrderAPI.orderShipmentAdd(orderShipmentAdd: orderShipmentAdd) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderShipmentAdd	OrderShipmentAdd

Return type

OrderShipmentAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderShipmentAddBatch

    open class func orderShipmentAddBatch(orderShipmentAddBatch: OrderShipmentAddBatch, completion: @escaping (_ data: CategoryAddBatch200Response?, _ error: Error?) -> Void)

order.shipment.add.batch

Add a shipments to the orders.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderShipmentAddBatch = OrderShipmentAddBatch(payload: [OrderShipmentAddBatch_payload_inner(orderId: "orderId_example", storeId: "storeId_example", warehouseId: "warehouseId_example", carrierId: "carrierId_example", carrierName: "carrierName_example", trackingNumber: "trackingNumber_example", trackingLink: "trackingLink_example", shipmentProvider: "shipmentProvider_example", items: [OrderShipmentAddBatch_payload_inner_items_inner(orderProductId: "orderProductId_example", quantity: 123)], sendNotifications: false)], idempotencyKey: "idempotencyKey_example") // OrderShipmentAddBatch | 

// order.shipment.add.batch
OrderAPI.orderShipmentAddBatch(orderShipmentAddBatch: orderShipmentAddBatch) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderShipmentAddBatch	OrderShipmentAddBatch

Return type

CategoryAddBatch200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderShipmentDelete

    open class func orderShipmentDelete(shipmentId: String, orderId: String, storeId: String? = nil, completion: @escaping (_ data: OrderShipmentDelete200Response?, _ error: Error?) -> Void)

order.shipment.delete

Delete order's shipment.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let shipmentId = "shipmentId_example" // String | Shipment id indicates the number of delivery
let orderId = "orderId_example" // String | Defines the order for which the shipment will be deleted
let storeId = "storeId_example" // String | Store Id (optional)

// order.shipment.delete
OrderAPI.orderShipmentDelete(shipmentId: shipmentId, orderId: orderId, storeId: storeId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
shipmentId	String	Shipment id indicates the number of delivery
orderId	String	Defines the order for which the shipment will be deleted
storeId	String	Store Id	[optional]

Return type

OrderShipmentDelete200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderShipmentEventAdd

    open class func orderShipmentEventAdd(orderShipmentEventAdd: OrderShipmentEventAdd, completion: @escaping (_ data: AttributeAdd200Response?, _ error: Error?) -> Void)

order.shipment.event.add

Add a tracking event to the shipment.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderShipmentEventAdd = OrderShipmentEventAdd(shipmentId: "shipmentId_example", orderId: "orderId_example", status: "status_example", storeId: "storeId_example", address1: "address1_example", city: "city_example", country: "country_example", state: "state_example", postcode: "postcode_example", message: "message_example", latitude: 123, longitude: 123, createdAt: "createdAt_example", estimatedDeliveryAt: "estimatedDeliveryAt_example", idempotencyKey: "idempotencyKey_example") // OrderShipmentEventAdd | 

// order.shipment.event.add
OrderAPI.orderShipmentEventAdd(orderShipmentEventAdd: orderShipmentEventAdd) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderShipmentEventAdd	OrderShipmentEventAdd

Return type

AttributeAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderShipmentEventList

    open class func orderShipmentEventList(shipmentId: String, orderId: String? = nil, storeId: String? = nil, start: Int? = nil, count: Int? = nil, pageCursor: String? = nil, responseFields: String? = nil, completion: @escaping (_ data: ModelResponseOrderShipmentEventList?, _ error: Error?) -> Void)

order.shipment.event.list

Get list of shipment tracking events.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let shipmentId = "shipmentId_example" // String | Defines the shipment for which tracking events will be retrieved
let orderId = "orderId_example" // String | Defines the order to which the shipment belongs (optional)
let storeId = "storeId_example" // String | Store Id (optional)
let start = 987 // Int | This parameter sets the number from which you want to get entities (optional) (default to 0)
let count = 987 // Int | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 (optional) (default to 10)
let pageCursor = "" // String | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) (optional)
let responseFields = "responseFields_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional)

// order.shipment.event.list
OrderAPI.orderShipmentEventList(shipmentId: shipmentId, orderId: orderId, storeId: storeId, start: start, count: count, pageCursor: pageCursor, responseFields: responseFields) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
shipmentId	String	Defines the shipment for which tracking events will be retrieved
orderId	String	Defines the order to which the shipment belongs	[optional]
storeId	String	Store Id	[optional]
start	Int	This parameter sets the number from which you want to get entities	[optional] [default to 0]
count	Int	This parameter sets the entity amount that has to be retrieved. Max allowed count=250	[optional] [default to 10]
pageCursor	String	Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)	[optional]
responseFields	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional]

Return type

ModelResponseOrderShipmentEventList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderShipmentInfo

    open class func orderShipmentInfo(id: String, orderId: String, start: Int? = nil, storeId: String? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: OrderShipmentInfo200Response?, _ error: Error?) -> Void)

order.shipment.info

Get information of shipment.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let id = "id_example" // String | Entity id
let orderId = "orderId_example" // String | Defines the order id
let start = 987 // Int | This parameter sets the number from which you want to get entities (optional) (default to 0)
let storeId = "storeId_example" // String | Store Id (optional)
let responseFields = "responseFields_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional)
let params = "params_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional) (default to "id,order_id,items,tracking_numbers")
let exclude = "exclude_example" // String | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional)

// order.shipment.info
OrderAPI.orderShipmentInfo(id: id, orderId: orderId, start: start, storeId: storeId, responseFields: responseFields, params: params, exclude: exclude) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	Entity id
orderId	String	Defines the order id
start	Int	This parameter sets the number from which you want to get entities	[optional] [default to 0]
storeId	String	Store Id	[optional]
responseFields	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
params	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to "id,order_id,items,tracking_numbers"]
exclude	String	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]

Return type

OrderShipmentInfo200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderShipmentList

    open class func orderShipmentList(orderId: String, start: Int? = nil, count: Int? = nil, pageCursor: String? = nil, storeId: String? = nil, createdFrom: String? = nil, createdTo: String? = nil, modifiedFrom: String? = nil, modifiedTo: String? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: ModelResponseOrderShipmentList?, _ error: Error?) -> Void)

order.shipment.list

Get list of shipments per order.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderId = "orderId_example" // String | Retrieves shipments specified by order id
let start = 987 // Int | This parameter sets the number from which you want to get entities (optional) (default to 0)
let count = 987 // Int | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 (optional) (default to 10)
let pageCursor = "" // String | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) (optional)
let storeId = "storeId_example" // String | Store Id (optional)
let createdFrom = "createdFrom_example" // String | Retrieve entities from their creation date (optional)
let createdTo = "createdTo_example" // String | Retrieve entities to their creation date (optional)
let modifiedFrom = "modifiedFrom_example" // String | Retrieve entities from their modification date (optional)
let modifiedTo = "modifiedTo_example" // String | Retrieve entities to their modification date (optional)
let responseFields = "responseFields_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional)
let params = "params_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional) (default to "id,order_id,items,tracking_numbers")
let exclude = "exclude_example" // String | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional)

// order.shipment.list
OrderAPI.orderShipmentList(orderId: orderId, start: start, count: count, pageCursor: pageCursor, storeId: storeId, createdFrom: createdFrom, createdTo: createdTo, modifiedFrom: modifiedFrom, modifiedTo: modifiedTo, responseFields: responseFields, params: params, exclude: exclude) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderId	String	Retrieves shipments specified by order id
start	Int	This parameter sets the number from which you want to get entities	[optional] [default to 0]
count	Int	This parameter sets the entity amount that has to be retrieved. Max allowed count=250	[optional] [default to 10]
pageCursor	String	Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)	[optional]
storeId	String	Store Id	[optional]
createdFrom	String	Retrieve entities from their creation date	[optional]
createdTo	String	Retrieve entities to their creation date	[optional]
modifiedFrom	String	Retrieve entities from their modification date	[optional]
modifiedTo	String	Retrieve entities to their modification date	[optional]
responseFields	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
params	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to "id,order_id,items,tracking_numbers"]
exclude	String	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]

Return type

ModelResponseOrderShipmentList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderShipmentTrackingAdd

    open class func orderShipmentTrackingAdd(orderShipmentTrackingAdd: OrderShipmentTrackingAdd, completion: @escaping (_ data: OrderShipmentTrackingAdd200Response?, _ error: Error?) -> Void)

order.shipment.tracking.add

Add order shipment's tracking info.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderShipmentTrackingAdd = OrderShipmentTrackingAdd(orderId: "orderId_example", shipmentId: "shipmentId_example", carrierId: "carrierId_example", storeId: "storeId_example", trackingProvider: "trackingProvider_example", trackingNumber: "trackingNumber_example", trackingLink: "trackingLink_example", sendNotifications: true, idempotencyKey: "idempotencyKey_example") // OrderShipmentTrackingAdd | 

// order.shipment.tracking.add
OrderAPI.orderShipmentTrackingAdd(orderShipmentTrackingAdd: orderShipmentTrackingAdd) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderShipmentTrackingAdd	OrderShipmentTrackingAdd

Return type

OrderShipmentTrackingAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderShipmentUpdate

    open class func orderShipmentUpdate(orderShipmentUpdate: OrderShipmentUpdate, completion: @escaping (_ data: AccountConfigUpdate200Response?, _ error: Error?) -> Void)

order.shipment.update

Update order's shipment information.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderShipmentUpdate = OrderShipmentUpdate(shipmentId: "shipmentId_example", orderId: "orderId_example", storeId: "storeId_example", shipmentProvider: "shipmentProvider_example", trackingNumbers: [OrderShipmentAdd_tracking_numbers_inner(carrierId: "carrierId_example", trackingNumber: "trackingNumber_example")], trackingLink: "trackingLink_example", isShipped: true, deliveredAt: "deliveredAt_example", replace: false, sendNotifications: true, trackingProvider: "trackingProvider_example", items: [OrderShipmentAdd_items_inner(orderProductId: "orderProductId_example", quantity: 123)], adminComment: "adminComment_example", idempotencyKey: "idempotencyKey_example") // OrderShipmentUpdate | 

// order.shipment.update
OrderAPI.orderShipmentUpdate(orderShipmentUpdate: orderShipmentUpdate) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderShipmentUpdate	OrderShipmentUpdate

Return type

AccountConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderStatusList

    open class func orderStatusList(storeId: String? = nil, action: String? = nil, allowUserDefinedOrderStatuses: Bool? = nil, responseFields: String? = nil, completion: @escaping (_ data: ModelResponseOrderStatusList?, _ error: Error?) -> Void)

order.status.list

Retrieve list of statuses

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let storeId = "storeId_example" // String | Store Id (optional)
let action = "action_example" // String | Available statuses for the specified action. (optional)
let allowUserDefinedOrderStatuses = true // Bool | Indicates whether custom (user-defined) order statuses should be included in the response. (optional) (default to false)
let responseFields = "responseFields_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional)

// order.status.list
OrderAPI.orderStatusList(storeId: storeId, action: action, allowUserDefinedOrderStatuses: allowUserDefinedOrderStatuses, responseFields: responseFields) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
storeId	String	Store Id	[optional]
action	String	Available statuses for the specified action.	[optional]
allowUserDefinedOrderStatuses	Bool	Indicates whether custom (user-defined) order statuses should be included in the response.	[optional] [default to false]
responseFields	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional]

Return type

ModelResponseOrderStatusList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderTransactionList

    open class func orderTransactionList(orderIds: String, count: Int? = nil, pageCursor: String? = nil, storeId: String? = nil, params: String? = nil, responseFields: String? = nil, exclude: String? = nil, completion: @escaping (_ data: ModelResponseOrderTransactionList?, _ error: Error?) -> Void)

order.transaction.list

Retrieve list of order transaction

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderIds = "orderIds_example" // String | Retrieves order transactions specified by order ids
let count = 987 // Int | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 (optional) (default to 10)
let pageCursor = "" // String | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) (optional)
let storeId = "storeId_example" // String | Store Id (optional)
let params = "params_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional) (default to "id,order_id,amount,description")
let responseFields = "responseFields_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional)
let exclude = "exclude_example" // String | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional)

// order.transaction.list
OrderAPI.orderTransactionList(orderIds: orderIds, count: count, pageCursor: pageCursor, storeId: storeId, params: params, responseFields: responseFields, exclude: exclude) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderIds	String	Retrieves order transactions specified by order ids
count	Int	This parameter sets the entity amount that has to be retrieved. Max allowed count=250	[optional] [default to 10]
pageCursor	String	Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)	[optional]
storeId	String	Store Id	[optional]
params	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to "id,order_id,amount,description"]
responseFields	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional]
exclude	String	Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all	[optional]

Return type

ModelResponseOrderTransactionList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

orderUpdate

    open class func orderUpdate(orderId: String, storeId: String? = nil, orderStatus: String? = nil, financialStatus: String? = nil, fulfillmentStatus: String? = nil, cancellationReason: String? = nil, orderPaymentMethod: String? = nil, comment: String? = nil, adminComment: String? = nil, adminPrivateComment: String? = nil, invoiceAdminComment: String? = nil, dateModified: String? = nil, dateFinished: String? = nil, sendNotifications: Bool? = nil, createInvoice: Bool? = nil, origin: String? = nil, tags: String? = nil, idempotencyKey: String? = nil, completion: @escaping (_ data: AccountConfigUpdate200Response?, _ error: Error?) -> Void)

order.update

Update existing order.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let orderId = "orderId_example" // String | Defines the orders specified by order id
let storeId = "storeId_example" // String | Defines store id where the order should be found (optional)
let orderStatus = "orderStatus_example" // String | Defines new order's status (optional)
let financialStatus = "financialStatus_example" // String | Update order financial status to specified (optional)
let fulfillmentStatus = "fulfillmentStatus_example" // String | Create order with fulfillment status (optional)
let cancellationReason = "cancellationReason_example" // String | Defines the cancellation reason when the order will be canceled (optional)
let orderPaymentMethod = "orderPaymentMethod_example" // String | Defines order payment method.<br/>Setting order_payment_method on Shopify will also change financial_status field value to 'paid' (optional)
let comment = "comment_example" // String | Specifies order comment (optional)
let adminComment = "adminComment_example" // String | Specifies admin's order comment (optional)
let adminPrivateComment = "adminPrivateComment_example" // String | Specifies private admin's order comment (optional)
let invoiceAdminComment = "invoiceAdminComment_example" // String | Specifies admin's order invoice comment (optional)
let dateModified = "dateModified_example" // String | Specifies order's  modification date (optional)
let dateFinished = "dateFinished_example" // String | Specifies order's  finished date (optional)
let sendNotifications = true // Bool | Send notifications to customer after order was created (optional) (default to false)
let createInvoice = true // Bool | Determines whether an invoice should be created if it has not already been created (optional)
let origin = "origin_example" // String | The source of the order (optional)
let tags = "tags_example" // String | Order tags (optional)
let idempotencyKey = "idempotencyKey_example" // String | A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong> (optional)

// order.update
OrderAPI.orderUpdate(orderId: orderId, storeId: storeId, orderStatus: orderStatus, financialStatus: financialStatus, fulfillmentStatus: fulfillmentStatus, cancellationReason: cancellationReason, orderPaymentMethod: orderPaymentMethod, comment: comment, adminComment: adminComment, adminPrivateComment: adminPrivateComment, invoiceAdminComment: invoiceAdminComment, dateModified: dateModified, dateFinished: dateFinished, sendNotifications: sendNotifications, createInvoice: createInvoice, origin: origin, tags: tags, idempotencyKey: idempotencyKey) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
orderId	String	Defines the orders specified by order id
storeId	String	Defines store id where the order should be found	[optional]
orderStatus	String	Defines new order's status	[optional]
financialStatus	String	Update order financial status to specified	[optional]
fulfillmentStatus	String	Create order with fulfillment status	[optional]
cancellationReason	String	Defines the cancellation reason when the order will be canceled	[optional]
orderPaymentMethod	String	Defines order payment method.<br/>Setting order_payment_method on Shopify will also change financial_status field value to 'paid'	[optional]
comment	String	Specifies order comment	[optional]
adminComment	String	Specifies admin's order comment	[optional]
adminPrivateComment	String	Specifies private admin's order comment	[optional]
invoiceAdminComment	String	Specifies admin's order invoice comment	[optional]
dateModified	String	Specifies order's modification date	[optional]
dateFinished	String	Specifies order's finished date	[optional]
sendNotifications	Bool	Send notifications to customer after order was created	[optional] [default to false]
createInvoice	Bool	Determines whether an invoice should be created if it has not already been created	[optional]
origin	String	The source of the order	[optional]
tags	String	Order tags	[optional]
idempotencyKey	String	A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>	[optional]

Return type

AccountConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

OrderAPI.md

Latest commit

History

OrderAPI.md

File metadata and controls

OrderAPI

orderAbandonedList

Example

Parameters

Return type

Authorization

HTTP request headers

orderAdd

Example

Parameters

Return type

Authorization

HTTP request headers

orderCalculate

Example

Parameters

Return type

Authorization

HTTP request headers

orderCount

Example

Parameters

Return type

Authorization

HTTP request headers

orderFinancialStatusList

Example

Parameters

Return type

Authorization

HTTP request headers

orderFulfillmentStatusList

Example

Parameters

Return type

Authorization

HTTP request headers

orderInfo

Example

Parameters

Return type

Authorization

HTTP request headers

orderList

Example

Parameters

Return type

Authorization

HTTP request headers

orderPreestimateShippingList

Example

Parameters

Return type

Authorization

HTTP request headers

orderRefundAdd

Example

Parameters

Return type

Authorization

HTTP request headers

orderReturnAdd

Example

Parameters

Return type

Authorization

HTTP request headers

orderReturnDelete

Example

Parameters

Return type

Authorization

HTTP request headers

orderReturnUpdate