Skip to content
aimrack

getSalesOrderRelatedItems

READ

Get sales order related items.

POST /api/v1/sales/getSalesOrderRelatedItems
curl -X POST '<your-host>/api/v1/sales/getSalesOrderRelatedItems' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "salesOrderId": "string",
    "opportunityId": "string"
  }'
Response
{
  "jobs": [
    {
      "actualTime": 0,
      "assignee": "string",
      "companyId": "string",
      "completedDate": "string",
      "configuration": "…",
      "createdAt": "string",
      "createdBy": "string",
      "customerId": "string",
      "customFields": "…",
      "deadlineType": "No Deadline",
      "dueDate": "string",
      "estimatedTime": 0,
      "id": "string",
      "itemId": "string",
      "jobId": "string",
      "locationId": "string",
      "notes": "…",
      "priority": 0,
      "productionQuantity": 0,
      "projectedCompletionAt": "string",
      "quantity": 0,
      "quantityComplete": 0,
      "quantityReceivedToInventory": 0,
      "quantityShipped": 0,
      "quoteId": "string",
      "quoteLineId": "string",
      "releasedDate": "string",
      "salesOrderId": "string",
      "salesOrderLineId": "string",
      "scheduleOutdatedAt": "string",
      "scheduleOutdatedReason": "string",
      "scrapQuantity": 0,
      "secondsToComplete": 0,
      "startDate": "string",
      "status": "Closed",
      "storageUnitId": "string",
      "tags": [
        "string"
      ],
      "unitOfMeasureCode": "string",
      "updatedAt": "string",
      "updatedBy": "string"
    }
  ],
  "shipments": [
    {
      "assignee": "string",
      "companyId": "string",
      "createdAt": "string",
      "createdBy": "string",
      "customerId": "string",
      "customFields": "…",
      "externalDocumentId": "string",
      "externalNotes": "…",
      "id": "string",
      "internalNotes": "…",
      "invoiced": true,
      "locationId": "string",
      "opportunityId": "string",
      "postedBy": "string",
      "postingDate": "string",
      "shipmentId": "string",
      "shippingMethodId": "string",
      "sourceDocument": "Sales Invoice",
      "sourceDocumentId": "string",
      "sourceDocumentReadableId": "string",
      "status": "Pending",
      "supplierId": "string",
      "supplierInteractionId": "string",
      "tags": [
        "string"
      ],
      "trackingNumber": "string",
      "updatedAt": "string",
      "updatedBy": "string",
      "shipmentLine": [
        {
          "companyId": "string",
          "createdAt": "string",
          "createdBy": "string",
          "fulfillmentId": "string",
          "id": "string",
          "itemId": "string",
          "lineId": "string",
          "locationId": "string",
          "orderQuantity": 0,
          "outstandingQuantity": 0,
          "requiresBatchTracking": true,
          "requiresSerialTracking": true,
          "shipmentId": "string",
          "shippedQuantity": 0,
          "storageUnitId": "string",
          "unitOfMeasure": "string",
          "unitPrice": 0,
          "updatedAt": "string",
          "updatedBy": "string"
        }
      ]
    }
  ],
  "invoices": [
    {
      "id": "string",
      "invoiceId": "string",
      "status": "Pending"
    }
  ],
  "salesReturnOrders": [
    {
      "id": "string",
      "salesReturnOrderId": "string",
      "status": "string"
    }
  ]
}

Parameters

ParameterType

Input schema

schema
{
  "type": "object",
  "properties": {
    "salesOrderId": {
      "type": "string"
    },
    "opportunityId": {
      "type": "string"
    }
  },
  "required": [
    "salesOrderId",
    "opportunityId"
  ]
}