Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "sdk-sales/src/sdk/getOrderDetails"

Index

Functions

Functions

getOrderDetails

  • getOrderDetails(orderNumber: string | undefined): Promise<OrderDetails | APIErrorResponse>
  • Parameters

    • orderNumber: string | undefined

    Returns Promise<OrderDetails | APIErrorResponse>

    A Promise which resolves to an object containing the details of an order. The data above will be merged into the orders array if one exists.

    On success (resolves)
    {
      "email": "test@test.com",
      "orderNumber": "1",
      "phone": "123-123-1234ß",
      "status": "1",
      "subtotal": 0,
      "total": 0,
      "totalTax": 0,
      "shipping": 0,
      "items": [
        {
          "sku": "string",
          "quantity": 0,
          "shortDescription": "string",
          "name": "string",
          "price": 0,
          "tax": 0,
          "subtotal": 0,
          "total": 0,
          "priceCode": "string"
        }
      ],
      "payments": [
        {
          "amount": 0,
          "paymentID": 0,
          "paymentMethod": {
            "creditCardType": "string",
            "firstSix": "string",
            "lastFour": "string",
            "expiration": "string",
            "cardHolderName": "string",
            "paymentPartner": "string",
            "paymentMethodID": 0
          },
          "financialTransactions": [
            {
              "amount": 0,
              "tax": 0,
              "subtotal": 0,
              "transactionType": "string",
              "transactionDate": "2019-05-28T11:54:39.878Z",
              "billingAddress": {
                "country": "string",
                "line1": "string",
                "line2": "string",
                "locality": "string",
                "region": "string",
                "postal": "string"
              }
            }
          ],
          "remainingAmountToRefund": 0
        }
      ],
      "billingAddress": {
        "country": "string",
        "line1": "string",
        "line2": "string",
        "locality": "string",
        "region": "string",
        "postal": "string"
      },
      "shippingAddress": {
        "country": "string",
        "line1": "string",
        "line2": "string",
        "locality": "string",
        "region": "string",
        "postal": "string"
      },
      "subscriptionIDs": [
        0
      ],
      "currency": "USD",
      "firstName": "test123",
      "lastName": "test123",
      "secondLastName": "test123",
      "orderDate": "1559084775000",
      "orderID": 1234,
      "clientID": "1a2b3c4d"
    }
    On error (rejects)
    See documentation for corresponding error codes:
    https://redirector.arcpublishing.com/alc/docs/swagger/?url=./arc-products/arc-sales.json#/Order_Interaction/getOrderDetail