NodeReceiving

nodeReceiving Query

Audience: Programmer

Fetches a receiving-related object given its ID. This query follows the Relay Global Object Identification Specification and can retrieve any object that implements the NodeReceiving interface.

Arguments

Name	Type	Description
id	ID!	The unique identifier of the receiving object to retrieve

Return Type

NodeReceiving - An interface that returns an object implementing the NodeReceiving interface. This includes:

• ReceivingInbound - An inbound receiving order containing items to be received

• ReceivingInboundItem - Individual item within a receiving inbound order

Usage Example

GraphQL Query

query GetReceivingObject($id: ID!) {
  nodeReceiving(id: $id) {
    id
    ... on ReceivingInbound {
      name
      status
      type
      data
      receivingSystemData
      createdAt
      updatedAt
      receivinginbounditems {
        edges {
          node {
            id
            quantity
            status
            item {
              sku
            }
          }
        }
      }
    }
    ... on ReceivingInboundItem {
      quantity
      status
      item {
        sku
        data
      }
      receivingInbound {
        name
        status
      }
    }
  }
}

Query Variables

{
  "id": "UmVjZWl2aW5nSW5ib3VuZDoxMjM="
}

JavaScript Example

const getReceivingObject = async (objectId) => {
  const query = `
    query GetReceivingObject($id: ID!) {
      nodeReceiving(id: $id) {
        id
        __typename
        ... on ReceivingInbound {
          name
          status
          type
          data
          createdAt
          updatedAt
        }
        ... on ReceivingInboundItem {
          quantity
          status
          item {
            sku
          }
          receivingInbound {
            name
          }
        }
      }
    }
  `;

  const response = await fetch('/graphql', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${accessToken}`
    },
    body: JSON.stringify({
      query,
      variables: { id: objectId }
    })
  });

  const { data } = await response.json();
  return data.nodeReceiving;
};

Type Detection

Use the __typename field to determine which specific type was returned:

const object = await getReceivingObject(id);
switch (object.__typename) {
  case 'ReceivingInbound':
    console.log(`Receiving Inbound: ${object.name}`);
    break;
  case 'ReceivingInboundItem':
    console.log(`Inbound Item SKU: ${object.item.sku}`);
    break;
}

Related

• NodeReceiving Interface

• ReceivingInbound Type

• ReceivingInboundItem Type

• receivingInbounds Query