Orders

orders

one OrderHeader (master: default)

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/orders/{orderId}

HTTPcURLJavaScriptPython

GET /rest/s1/poorti/orders/{orderId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "org.apache.ofbiz.order.order.OrderHeader",
  "orderId": "text",
  "orderTypeId": "text",
  "orderName": "text",
  "externalId": "text",
  "salesChannelEnumId": "text",
  "orderDate": "2025-12-16T04:06:46.984Z",
  "priority": "text",
  "entryDate": "2025-12-16T04:06:46.984Z",
  "pickSheetPrintedDate": "2025-12-16T04:06:46.984Z",
  "visitId": "text",
  "statusId": "text",
  "createdBy": "text",
  "firstAttemptOrderId": "text",
  "currencyUom": "text",
  "syncStatusId": "text",
  "billingAccountId": "text",
  "originFacilityId": "text",
  "webSiteId": "text",
  "productStoreId": "text",
  "terminalId": "text",
  "transactionId": "text",
  "autoOrderShoppingListId": "text",
  "needsInventoryIssuance": "text",
  "isRushOrder": "text",
  "internalCode": "text",
  "remainingSubTotal": 1,
  "grandTotal": 1,
  "isViewed": "text",
  "invoicePerShipment": "text",
  "expireDate": "2025-12-16T04:06:46.984Z",
  "localeString": "text",
  "customerClassificationId": "text",
  "presentmentCurrencyUom": "text",
  "autoApprove": "text",
  "statusFlowId": "text",
  "lastUpdatedStamp": "2025-12-16T04:06:46.984Z",
  "roles": [
    {
      "_entity": "org.apache.ofbiz.order.order.OrderRole",
      "orderId": "text",
      "partyId": "text",
      "roleTypeId": "text",
      "fromDate": "2025-12-16T04:06:46.984Z",
      "thruDate": "2025-12-16T04:06:46.984Z",
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
    }
  ],
  "contactMechs": [
    {
      "_entity": "org.apache.ofbiz.order.order.OrderContactMech",
      "orderId": "text",
      "contactMechPurposeTypeId": "text",
      "contactMechId": "text",
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z",
      "contactMech": {
        "_entity": "org.apache.ofbiz.party.contact.ContactMech",
        "contactMechId": "text",
        "externalId": "text",
        "contactMechTypeId": "text",
        "infoString": "text",
        "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
      },
      "postalAddress": {
        "_entity": "org.apache.ofbiz.party.contact.PostalAddress",
        "contactMechId": "text",
        "toName": "text",
        "attnName": "text",
        "address1": "text",
        "address2": "text",
        "houseNumber": 1,
        "houseNumberExt": "text",
        "directions": "text",
        "city": "text",
        "cityGeoId": "text",
        "postalCode": "text",
        "postalCodeExt": "text",
        "countryGeoId": "text",
        "stateProvinceGeoId": "text",
        "countyGeoId": "text",
        "municipalityGeoId": "text",
        "postalCodeGeoId": "text",
        "geoPointId": "text",
        "encodedAddressKey": "text",
        "latitude": 1,
        "longitude": 1,
        "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
      },
      "telecomNumber": {
        "_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
        "contactMechId": "text",
        "countryCode": "text",
        "areaCode": "text",
        "contactNumber": "text",
        "askForName": "text",
        "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
      }
    }
  ],
  "paymentPreferences": [
    {
      "_entity": "org.apache.ofbiz.order.order.OrderPaymentPreference",
      "orderPaymentPreferenceId": "text",
      "orderId": "text",
      "orderItemSeqId": "text",
      "shipGroupSeqId": "text",
      "productPricePurposeId": "text",
      "paymentMethodTypeId": "text",
      "paymentMethodId": "text",
      "finAccountId": "text",
      "securityCode": "text",
      "track2": "text",
      "presentFlag": "text",
      "swipedFlag": "text",
      "overflowFlag": "text",
      "maxAmount": 1,
      "processAttempt": 1,
      "billingPostalCode": "text",
      "manualAuthCode": "text",
      "manualRefNum": "text",
      "statusId": "text",
      "needsNsfRetry": "text",
      "createdDate": "2025-12-16T04:06:46.984Z",
      "createdByUserLogin": "text",
      "lastModifiedDate": "2025-12-16T04:06:46.984Z",
      "lastModifiedByUserLogin": "text",
      "paymentMode": "text",
      "cardName": "text",
      "presentmentAmount": 1,
      "presentmentCurrencyUom": "text",
      "exchangeRate": 1,
      "requestId": "text",
      "parentRefNum": "text",
      "applicationIdentifier": "text",
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z",
      "moqui.basic.StatusItem": {
        "_entity": "statuses",
        "statusId": "text",
        "statusTypeId": "text",
        "statusCode": "text",
        "sequenceNum": 1,
        "description": "text",
        "statusAge": 1,
        "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
      },
      "org.apache.ofbiz.accounting.payment.PaymentMethodType": {
        "_entity": "org.apache.ofbiz.accounting.payment.PaymentMethodType",
        "paymentMethodTypeId": "text",
        "description": "text",
        "defaultGlAccountId": "text",
        "paymentMethodCode": "text",
        "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
      }
    }
  ],
  "adjustments": [
    {
      "_entity": "org.apache.ofbiz.order.order.OrderAdjustment",
      "orderAdjustmentId": "text",
      "orderAdjustmentTypeId": "text",
      "orderId": "text",
      "orderItemSeqId": "text",
      "shipGroupSeqId": "text",
      "comments": "text",
      "description": "text",
      "amount": 1,
      "recurringAmount": 1,
      "amountAlreadyIncluded": 1,
      "productPromoId": "text",
      "productPromoRuleId": "text",
      "productPromoActionSeqId": "text",
      "productFeatureId": "text",
      "correspondingProductId": "text",
      "taxAuthorityRateSeqId": "text",
      "sourceReferenceId": "text",
      "sourcePercentage": 1,
      "customerReferenceId": "text",
      "primaryGeoId": "text",
      "secondaryGeoId": "text",
      "exemptAmount": 1,
      "taxAuthGeoId": "text",
      "taxAuthPartyId": "text",
      "overrideGlAccountId": "text",
      "includeInTax": "text",
      "includeInShipping": "text",
      "isManual": "text",
      "createdDate": "2025-12-16T04:06:46.984Z",
      "createdByUserLogin": "text",
      "lastModifiedDate": "2025-12-16T04:06:46.984Z",
      "lastModifiedByUserLogin": "text",
      "originalAdjustmentId": "text",
      "oldAmountPerQuantity": 1,
      "oldPercentage": 1,
      "billingShipmentId": "text",
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z",
      "attributes": [
        {
          "_entity": "org.apache.ofbiz.order.order.OrderAdjustmentAttribute",
          "orderAdjustmentId": "text",
          "attrName": "text",
          "attrValue": "text",
          "attrDescription": "text",
          "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
        }
      ]
    }
  ],
  "attributes": [
    {
      "_entity": "org.apache.ofbiz.order.order.OrderAttribute",
      "orderId": "text",
      "attrName": "text",
      "attrValue": "text",
      "attrDescription": "text",
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
    }
  ],
  "notes": [
    {
      "_entity": "org.apache.ofbiz.order.order.OrderHeaderNote",
      "orderId": "text",
      "noteId": "text",
      "internalNote": "text",
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
    }
  ],
  "shipGroups": [
    {
      "_entity": "org.apache.ofbiz.order.order.OrderItemShipGroup",
      "orderId": "text",
      "shipGroupSeqId": "text",
      "shipmentMethodTypeId": "text",
      "supplierPartyId": "text",
      "vendorPartyId": "text",
      "carrierPartyId": "text",
      "carrierRoleTypeId": "text",
      "facilityId": "text",
      "contactMechId": "text",
      "telecomContactMechId": "text",
      "trackingNumber": "text",
      "shippingInstructions": "text",
      "maySplit": "text",
      "giftMessage": "text",
      "isGift": "text",
      "shipAfterDate": "2025-12-16T04:06:46.984Z",
      "shipByDate": "2025-12-16T04:06:46.984Z",
      "estimatedShipDate": "2025-12-16T04:06:46.984Z",
      "estimatedDeliveryDate": "2025-12-16T04:06:46.984Z",
      "carrierAccountNumber": "text",
      "carrierService": "text",
      "orderFacilityId": "text",
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z",
      "items": [
        {
          "_entity": "org.apache.ofbiz.order.order.OrderItem",
          "orderId": "text",
          "orderItemSeqId": "text",
          "externalId": "text",
          "orderItemTypeId": "text",
          "orderItemGroupSeqId": "text",
          "isItemGroupPrimary": "text",
          "fromInventoryItemId": "text",
          "budgetId": "text",
          "budgetItemSeqId": "text",
          "productId": "text",
          "supplierProductId": "text",
          "productFeatureId": "text",
          "prodCatalogId": "text",
          "productCategoryId": "text",
          "isPromo": "text",
          "quoteId": "text",
          "quoteItemSeqId": "text",
          "shoppingListId": "text",
          "shoppingListItemSeqId": "text",
          "subscriptionId": "text",
          "deploymentId": "text",
          "quantity": 1,
          "cancelQuantity": 1,
          "selectedAmount": 1,
          "unitPrice": 1,
          "unitListPrice": 1,
          "unitAverageCost": 1,
          "unitRecurringPrice": 1,
          "isModifiedPrice": "text",
          "recurringFreqUomId": "text",
          "itemDescription": "text",
          "comments": "text",
          "correspondingPoId": "text",
          "statusId": "text",
          "syncStatusId": "text",
          "estimatedShipDate": "2025-12-16T04:06:46.984Z",
          "estimatedDeliveryDate": "2025-12-16T04:06:46.984Z",
          "autoCancelDate": "2025-12-16T04:06:46.984Z",
          "dontCancelSetDate": "2025-12-16T04:06:46.984Z",
          "dontCancelSetUserLogin": "text",
          "shipBeforeDate": "2025-12-16T04:06:46.984Z",
          "shipAfterDate": "2025-12-16T04:06:46.984Z",
          "cancelBackOrderDate": "2025-12-16T04:06:46.984Z",
          "overrideGlAccountId": "text",
          "salesOpportunityId": "text",
          "changeByUserLoginId": "text",
          "shipGroupSeqId": "text",
          "returnTillDate": "2025-12-16T04:06:46.984Z",
          "promisedDatetime": "2025-12-16T04:06:46.984Z",
          "shipmentId": "text",
          "isNewProduct": "text",
          "availableToPromise": 1,
          "requestedDeliveryDate": "2025-12-16",
          "requestedDeliveryTime": "text",
          "requestedShipMethTypeId": "text",
          "deliveryWindow": 1,
          "taxCode": "text",
          "lastUpdatedStamp": "2025-12-16T04:06:46.984Z",
          "adjustments": [
            {
              "_entity": "org.apache.ofbiz.order.order.OrderAdjustment",
              "orderAdjustmentId": "text",
              "orderAdjustmentTypeId": "text",
              "orderId": "text",
              "orderItemSeqId": "text",
              "shipGroupSeqId": "text",
              "comments": "text",
              "description": "text",
              "amount": 1,
              "recurringAmount": 1,
              "amountAlreadyIncluded": 1,
              "productPromoId": "text",
              "productPromoRuleId": "text",
              "productPromoActionSeqId": "text",
              "productFeatureId": "text",
              "correspondingProductId": "text",
              "taxAuthorityRateSeqId": "text",
              "sourceReferenceId": "text",
              "sourcePercentage": 1,
              "customerReferenceId": "text",
              "primaryGeoId": "text",
              "secondaryGeoId": "text",
              "exemptAmount": 1,
              "taxAuthGeoId": "text",
              "taxAuthPartyId": "text",
              "overrideGlAccountId": "text",
              "includeInTax": "text",
              "includeInShipping": "text",
              "isManual": "text",
              "createdDate": "2025-12-16T04:06:46.984Z",
              "createdByUserLogin": "text",
              "lastModifiedDate": "2025-12-16T04:06:46.984Z",
              "lastModifiedByUserLogin": "text",
              "originalAdjustmentId": "text",
              "oldAmountPerQuantity": 1,
              "oldPercentage": 1,
              "billingShipmentId": "text",
              "lastUpdatedStamp": "2025-12-16T04:06:46.984Z",
              "attributes": [
                {
                  "_entity": "org.apache.ofbiz.order.order.OrderAdjustmentAttribute",
                  "orderAdjustmentId": "text",
                  "attrName": "text",
                  "attrValue": "text",
                  "attrDescription": "text",
                  "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
                }
              ]
            }
          ],
          "attributes": [
            {
              "_entity": "org.apache.ofbiz.order.order.OrderItemAttribute",
              "orderId": "text",
              "orderItemSeqId": "text",
              "attrName": "text",
              "attrValue": "text",
              "attrDescription": "text",
              "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
            }
          ],
          "statuses": [
            {
              "_entity": "org.apache.ofbiz.order.order.OrderStatus",
              "orderStatusId": "text",
              "statusId": "text",
              "orderId": "text",
              "orderItemSeqId": "text",
              "orderPaymentPreferenceId": "text",
              "statusDatetime": "2025-12-16T04:06:46.984Z",
              "statusUserLogin": "text",
              "changeReason": "text",
              "changeReasonEnumId": "text",
              "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
            }
          ]
        }
      ]
    }
  ],
  "statuses": [
    {
      "_entity": "org.apache.ofbiz.order.order.OrderStatus",
      "orderStatusId": "text",
      "statusId": "text",
      "orderId": "text",
      "orderItemSeqId": "text",
      "orderPaymentPreferenceId": "text",
      "statusDatetime": "2025-12-16T04:06:46.984Z",
      "statusUserLogin": "text",
      "changeReason": "text",
      "changeReasonEnumId": "text",
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
    }
  ],
  "identifications": [
    {
      "_entity": "co.hotwax.order.OrderIdentification",
      "orderIdentificationTypeId": "text",
      "orderId": "text",
      "idValue": "text",
      "fromDate": "2025-12-16T04:06:46.984Z",
      "thruDate": "2025-12-16T04:06:46.984Z",
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
    }
  ],
  "itemAssocs": [
    {
      "_entity": "org.apache.ofbiz.order.order.OrderItemAssoc",
      "orderId": "text",
      "orderItemSeqId": "text",
      "shipGroupSeqId": "text",
      "toOrderId": "text",
      "toOrderItemSeqId": "text",
      "toShipGroupSeqId": "text",
      "orderItemAssocTypeId": "text",
      "quantity": 1,
      "lastUpdatedStamp": "2025-12-16T04:06:46.984Z"
    }
  ]
}