Skip to content

Files

Latest commit

 

History

History
804 lines (561 loc) · 29 KB

OrderAPI.md

File metadata and controls

804 lines (561 loc) · 29 KB

OrderAPI

All URIs are relative to https://mgmtapi.geins.io

Method HTTP request Description
addCommentToOrder POST /API/Order/{id}/Comment Adds a comment to the order
createOrder POST /API/Order Post a new order
createOrderId POST /API/Order/Id Create a new order id
deleteOrder DELETE /API/Order/{id} Deletes or deactivates an order
getCaptureById GET /API/Order/Capture/{captureId} Get Capture by Id
getOrderById GET /API/Order/{id}/{include} Get an instance of a order
getOrderStatuses GET /API/Order/Statuses Get a list of available order statuses
getRefundById GET /API/Order/Refund/{refundId} Get Refund by Id
partialUpdateOfOrder PATCH /API/Order/{id} Partial update of an order
queryOrders POST /API/Order/Query Query the order repository
setCaptureAsProcessed POST /API/Order/Capture/SetAsProcessed Set a capture as processed (= captured)
setPaymentAsPayed POST /API/Order/PaymentDetail/{paymentDetailId}/SetAsPayed Set Payment Detail as payed
setRefundAsProcessed POST /API/Order/Refund/SetAsProcessed Set a refund as processed (= settled)
updateOrderStatus POST /API/Order/{id}/Status/{status}/{transactionId}/{secondaryTransactionId} Update order status
updateTransactionData POST /API/Order/{id}/TransactionData Updates transaction data on an order
validateOrder POST /API/Order/ValidateCreation Validates order data for order creation.

addCommentToOrder

    open class func addCommentToOrder(id: Int, orderComment: APIOrderOrderComment, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Adds a comment to the order

This add to (not replace) any previous comments.

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 = 987 // Int | Order ID.
let orderComment = API.Order.OrderComment(orderId: 123, comment: "comment_example", system: false) // APIOrderOrderComment | The comment

// Adds a comment to the order
OrderAPI.addCommentToOrder(id: id, orderComment: orderComment) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id Int Order ID.
orderComment APIOrderOrderComment The comment

Return type

AnyCodable

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

createOrder

    open class func createOrder(order: OrderModelsOrder, completion: @escaping (_ data: EnvelopeInt?, _ error: Error?) -> Void)

Post a new 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 order = Order.Models.Order(id: 123, externalId: "externalId_example", personalId: "personalId_example", customerId: 123, customerTypeId: 123, createdAt: Date(), updatedAt: Date(), completedAt: Date(), status: "status_example", currency: "currency_example", currencyRate: 123, marketId: 123, marketName: "marketName_example", language: "language_example", orderTotal: 123, expectedSum: 123, vATTotal: 123, orderValueIncVat: 123, orderValueExVat: 123, itemValueIncVat: 123, itemValueExVat: 123, discount: 123, discountExVat: 123, fromBalance: 123, shippingFee: 123, shippingFeeExVat: 123, paymentFee: 123, paymentFeeExVat: 123, message: "message_example", orderMessages: ["orderMessages_example"], paymentDetails: [Order.Models.PaymentDetail(id: 123, paymentId: 123, name: "name_example", displayName: "displayName_example", transactionId: "transactionId_example", secondaryTransactionId: "secondaryTransactionId_example", reservationNumber: "reservationNumber_example", reservationDate: Date(), paymentDate: Date(), total: 123, payed: false, paymentFee: 123, shippingFee: 123, paymentOption: "paymentOption_example")], shippingDetails: [Order.Models.ShippingDetail(id: 123, shippingId: 123, name: "name_example", parcelNumber: "parcelNumber_example", shippingDate: Date(), trackingUrl: "trackingUrl_example", externalDeliveryOptionId: "externalDeliveryOptionId_example", externalServiceId: "externalServiceId_example", externalCarrierId: "externalCarrierId_example", pickupPoint: "pickupPoint_example")], shippingAddress: Order.Models.Address(company: "company_example", careOf: "careOf_example", state: "state_example", country: "country_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", addressLine1: "addressLine1_example", addressLine2: "addressLine2_example", addressLine3: "addressLine3_example", zip: "zip_example", city: "city_example", phone: "phone_example", mobile: "mobile_example", entryCode: "entryCode_example"), billingAddress: nil, rows: [Order.Models.OrderRow(id: 123)], refunds: [Order.Models.Refund(id: 123, orderRowId: 123, paymentDetailId: 123, returnId: 123, articleNumber: "articleNumber_example", createdAt: Date(), total: 123, reasonCode: 123, reason: "reason_example", toBalance: false, vat: 123, itemId: 123, refundType: "refundType_example")], ip: "ip_example", userAgent: "userAgent_example", serviceLocation: "serviceLocation_example", campaignCode: "campaignCode_example", campaignCodeId: 123, percent: 123, desiredDeliveryDate: Date(), gender: false, cartId: 123, sessionId: "sessionId_example", externalOrderStatus: 123, campaignIds: ["campaignIds_example"], campaignNames: ["campaignNames_example"], metaData: "TODO", publicId: 123) // OrderModelsOrder | The order object.

// Post a new order
OrderAPI.createOrder(order: order) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
order OrderModelsOrder The order object.

Return type

EnvelopeInt

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

createOrderId

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

Create a new order 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


// Create a new order id
OrderAPI.createOrderId() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

EnvelopeInt

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

deleteOrder

    open class func deleteOrder(id: Int, operation: Operation_deleteOrder, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Deletes or deactivates an 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 id = 987 // Int | The ID of the order to delete.
let operation = 987 // Int | The method of deletion desired.

// Deletes or deactivates an order
OrderAPI.deleteOrder(id: id, operation: operation) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id Int The ID of the order to delete.
operation Int The method of deletion desired.

Return type

AnyCodable

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

getCaptureById

    open class func getCaptureById(captureId: UUID, completion: @escaping (_ data: OrderCapture?, _ error: Error?) -> Void)

Get Capture 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 captureId = 987 // UUID | Capture ID.

// Get Capture by Id
OrderAPI.getCaptureById(captureId: captureId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
captureId UUID Capture ID.

Return type

OrderCapture

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

getOrderById

    open class func getOrderById(id: Int, include: String, combineProductContainerRows: Bool? = nil, completion: @escaping (_ data: OrderModelsOrder?, _ error: Error?) -> Void)

Get an instance of a 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 id = 987 // Int | The ID of the order to get.
let include = "include_example" // String | A comma separated string of what related collections to include with this result set. The  possible values are: rows, paymentdetails, shippingdetails and refunds.
let combineProductContainerRows = true // Bool | If true, will combine all order rows that are part of a container into a single container row. (optional)

// Get an instance of a order
OrderAPI.getOrderById(id: id, include: include, combineProductContainerRows: combineProductContainerRows) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id Int The ID of the order to get.
include String A comma separated string of what related collections to include with this result set. The possible values are: rows, paymentdetails, shippingdetails and refunds.
combineProductContainerRows Bool If true, will combine all order rows that are part of a container into a single container row. [optional]

Return type

OrderModelsOrder

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

getOrderStatuses

    open class func getOrderStatuses(completion: @escaping (_ data: [OrderModelsOrderStatus]?, _ error: Error?) -> Void)

Get a list of available order 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


// Get a list of available order statuses
OrderAPI.getOrderStatuses() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[OrderModelsOrderStatus]

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

getRefundById

    open class func getRefundById(refundId: UUID, completion: @escaping (_ data: OrderRefund?, _ error: Error?) -> Void)

Get Refund 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 refundId = 987 // UUID | Refund ID.

// Get Refund by Id
OrderAPI.getRefundById(refundId: refundId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
refundId UUID Refund ID.

Return type

OrderRefund

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

partialUpdateOfOrder

    open class func partialUpdateOfOrder(id: Int, order: OrderModelsOrderUpdate, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Partial update of an 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 id = 987 // Int | The orderId of the order to update
let order = Order.Models.OrderUpdate(externalId: "externalId_example", parcelNumber: "parcelNumber_example", externalOrderStatus: 123) // OrderModelsOrderUpdate | The order object containing the properties that should be updated.

// Partial update of an order
OrderAPI.partialUpdateOfOrder(id: id, order: order) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id Int The orderId of the order to update
order OrderModelsOrderUpdate The order object containing the properties that should be updated.

Return type

AnyCodable

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

queryOrders

    open class func queryOrders(query: OrderModelsOrderQuery, completion: @escaping (_ data: [OrderModelsOrder]?, _ error: Error?) -> Void)

Query the order repository

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 query = Order.Models.OrderQuery(updated: Date(), statusList: "statusList_example", marketId: 123, paymentName: "paymentName_example", parcelGroupId: 123, customerId: 123, email: "email_example", include: "include_example", externalOrderStatus: 123, combineProductContainerRows: false, packingLocationId: 123) // OrderModelsOrderQuery | The details of the query.

// Query the order repository
OrderAPI.queryOrders(query: query) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
query OrderModelsOrderQuery The details of the query.

Return type

[OrderModelsOrder]

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

setCaptureAsProcessed

    open class func setCaptureAsProcessed(processedCapture: OrderProcessedCapture, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Set a capture as processed (= captured)

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 processedCapture = Order.ProcessedCapture(captureId: 123, externalId: "externalId_example", reference: "reference_example", processedOn: Date()) // OrderProcessedCapture | Contains CaptureId and optional metadata about capture.

// Set a capture as processed (= captured)
OrderAPI.setCaptureAsProcessed(processedCapture: processedCapture) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
processedCapture OrderProcessedCapture Contains CaptureId and optional metadata about capture.

Return type

AnyCodable

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

setPaymentAsPayed

    open class func setPaymentAsPayed(paymentDetailId: Int, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Set Payment Detail as payed

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 paymentDetailId = 987 // Int | Payment Detail ID.

// Set Payment Detail as payed
OrderAPI.setPaymentAsPayed(paymentDetailId: paymentDetailId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
paymentDetailId Int Payment Detail ID.

Return type

AnyCodable

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

setRefundAsProcessed

    open class func setRefundAsProcessed(processedRefund: OrderProcessedRefund, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Set a refund as processed (= settled)

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 processedRefund = Order.ProcessedRefund(refundId: 123, externalId: "externalId_example", reference: "reference_example", processedOn: Date()) // OrderProcessedRefund | Contains RefundId and optional metadata about refund.

// Set a refund as processed (= settled)
OrderAPI.setRefundAsProcessed(processedRefund: processedRefund) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
processedRefund OrderProcessedRefund Contains RefundId and optional metadata about refund.

Return type

AnyCodable

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

updateOrderStatus

    open class func updateOrderStatus(id: Int, status: Status_updateOrderStatus, transactionId: String, secondaryTransactionId: String, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Update order status

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 = 987 // Int | Order ID.
let status = 987 // Int | Order status. These statuses can be set: cancelled, on-hold, inactive, out-of-stock,  backorder, completed, pending.
let transactionId = "transactionId_example" // String | A transaction id can be set here if status is set to pending.
let secondaryTransactionId = "secondaryTransactionId_example" // String | A secondary transaction id, if any, can be set here if status is set to pending.

// Update order status
OrderAPI.updateOrderStatus(id: id, status: status, transactionId: transactionId, secondaryTransactionId: secondaryTransactionId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id Int Order ID.
status Int Order status. These statuses can be set: cancelled, on-hold, inactive, out-of-stock, backorder, completed, pending.
transactionId String A transaction id can be set here if status is set to pending.
secondaryTransactionId String A secondary transaction id, if any, can be set here if status is set to pending.

Return type

AnyCodable

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

updateTransactionData

    open class func updateTransactionData(id: Int, transactionData: APIOrderTransactionData, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Updates transaction data on an 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 id = 987 // Int | Order ID.
let transactionData = API.Order.TransactionData(orderId: 123, transactionId: "transactionId_example") // APIOrderTransactionData | The transaction data

// Updates transaction data on an order
OrderAPI.updateTransactionData(id: id, transactionData: transactionData) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
id Int Order ID.
transactionData APIOrderTransactionData The transaction data

Return type

AnyCodable

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

validateOrder

    open class func validateOrder(request: OrderValidateOrderCreationRequest, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Validates order data for order creation.

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 request = Order.ValidateOrderCreationRequest(orderId: 123, userId: 123, email: "email_example", phone: "phone_example", currency: "currency_example", sumIncVat: 123, balanceIncVat: 123, items: [Order.ValidateOrderCreationRequest.StockItem(itemId: 123, quantity: 123)]) // OrderValidateOrderCreationRequest | The order data to validate.

// Validates order data for order creation.
OrderAPI.validateOrder(request: request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
request OrderValidateOrderCreationRequest The order data to validate.

Return type

AnyCodable

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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