R2net jXnet API docs

authentication


To ensure a secure authentication process, please include the passport-token in the header of your POST request when making any API requests.
        
  • Token is valid for 12 hours
  • The token should be added to the header as x-access-passport-token
Use "passport-api" to obtain a passport token
Api url: https://passport-api.services.r2net.com/auth
              
{
  login(username: "john", password: "fakePassword", loginAsAppId: "jxnet") {
    token
    status
    isPasswordExpired
  } 
}                

              
          

Orders/v/3

https://jxnet-api.services.r2net.com/orders/v/3/

order details

Retrieves an order by its unique identifier.
  • Input: id: ID! - The unique identifier of the order
  • Output: Order - The details of the order.
          
{
    order(id: 12345) {
    websiteCode
    orderID
    lastUpdate
    nyInstructionsDate
    nyInstructions
    customerID
    customerName
    createDate
    shippingDate
    webDate
    items {
      orderItemID
      sku
      img
      vendorSku 
      ...   
    }
    shippingDateOSM
    jXnetDate
    isOnjXnet
    isHardDeadline
    isPrinted
    printingTimeStamp
    alertStatusID
    isFlagedShipping
    isSaturday
    isAutoFlagedShipping
    shippingRegion
    isFastLane
    fastLaneDay
    ...
    }
}
          
    
you can add any field from order schema that you find in graphiQL playground docs.

orders details

Retrieves orders by their unique identifiers.
  • Input: ids: [ID]! - The unique identifier of the orders
  • Output: [Orders] - The details of the orders.
          
{
    orders(ids: [12345, 34567]) {
      websiteCode
      orderID
      lastUpdate
      nyInstructionsDate
      nyInstructions
      customerID
      customerName
      createDate
      shippingDate
      webDate
      items {
        orderItemID
        sku
        img
        vendorSku 
        ...   
      }
      shippingDateOSM
      jXnetDate
      isOnjXnet
      isHardDeadline
      isPrinted
      printingTimeStamp
      alertStatusID
      isFlagedShipping
      isSaturday
      isAutoFlagedShipping
      shippingRegion
      isFastLane
      fastLaneDay
      ...
    }
}
          
    
you can add any field from order schema that you find in graphiQL playground docs.

Open Orders

openOrders query can be used to retrieve a list of open orders.
  • lastUpdate (String): Specify a date string to filter the results. Return only the orders that were updated after the provided timestamp.
  • limit (Int): Maximum number of orders to be returned in the result.
  • skip (Int): Skip a certain number of orders from the beginning of the list. It is useful for pagination purposes, where you can retrieve a subset of orders at a time.
  • tabName (String): filter the orders based on a specific tab or category. Return only the orders that belong to the specified tab (Default is 'all').
tabName values: all, today, new, in process, shipped to NY, NY received, Memo
          {
  openOrders(limit: $limit, skip: $currentListLength, tabName: $tabName) {
    websiteCode
    orderID
    customerName
    shippingDateOSM
    shippingDate
    isHardDeadline
    isPrinted
    alertStatusID
    isFlagedShipping
    isFastLane
    fastLaneDay
    address {
      shipping {
        country {
          name
        }
      }
    }
    items {
      supplier {
        name
      }
    }
    jXnetStatus {
      id
      name
    }
    status{
      id
      name
    }
    osmStatus {
      id
    }
  }

          

          
variables: {
  "limit": 100,
  "currentListLength": 0,
  "tabName": "new"
}
          
    
you can add any field from order schema that you find in graphiQL playground docs.

Search Orders

The searchOrders enables you to search for orders based on orderID or customer name. It takes two parameters:
  • regex (String!): This parameter accepts a regular expression (regex) string as input.
  • byOrder (Boolean!): if true , the search will be performed specifically on the order id, if false, by customer name
  • Output: [Orders] - The details of the orders.
          
{
  searchOrders(regex: String, byOrder: Boolean) {
    orderID
    customerName
  }
}
          
      
you can add any field from order schema that you find in graphiQL playground docs.

Order By ShippDate

The ordersByShippingDate allows you to retrieve a list of orders based on a specific shipping date.
  • shippingDate (String): Date string as input, specifying the desired shipping date. Return a list of orders that are scheduled to be shipped on the provided date
  • Output: Order - The details of the order.
          
{
  ordersByShippingDate(shippingDate: "2023-07-07T14:27:18.702Z") {
      websiteCode
      orderID
      lastUpdate
      nyInstructionsDate
      nyInstructions
      customerID
      customerName
      createDate
      shippingDate
      webDate
      shippingDateOSM
      jXnetDate
      isOnjXnet
      isHardDeadline
      isPrinted
      printingTimeStamp
      alertStatusID
      isFlagedShipping
      isSaturday
      isAutoFlagedShipping
      shippingRegion
      isFastLane
      fastLaneDay
    }
}
          
       
you can add any field from order schema that you find in graphiQL playground docs.

Batch Started

The batchStarted mutation is used to modify the status of a batch, indicating whether it has been started. It takes two parameters:
  • items ([batchGridInputItem]): Array of batchGridInputItem objects. Each batchGridInputItem represents an item within the batch that you want to update the status for.
  • isStarted (Boolean): If isStarted is true, it signifies that the batch has been started. If it is set to false, it indicates that the batch has not been started.
  • Output: Boolean - if the update operation fails for any reason, it will return false.
          
mutation ( $items: [batchGridInputItem], $isStarted: Boolean) {
  batchStarted(items: $items, isStarted: $isStarted)
}

      
      
variables: {
  "items":[
      {
        "src": "JA",
        "orderID": 12345,
        "orderItemID": 1234567
      }
    ],
    "isStarted": true
}
      
        
you can add any field from order schema that you find in graphiQL playground docs.

Batch Received

The batchReceived mutation is used to update the status of a batch, specifically indicating that it has been received. It takes two parameters:
  • items ([batchGridInputItem]): Array of batchGridInputItem objects. Each batchGridInputItem represents an item within the batch that you want to update the status for.
  • approvedBy (String): Specifies the name of the person who approved or received the batch. It expects a string value representing the approver's name.
  • Output: Boolean - if the update operation fails for any reason, it will return false.
 
          
mutation  {
  batchReceived(items: [batchGridInputItem], approvedBy: String)
}
          

      
variables: {
  "items":[
      {
        "src": "JA",
        "orderID": 12345,
        "orderItemID": 1234567
      }
    ],
    "approvedBy": "john"
}
                        
       
you can add any field from order schema that you find in graphiQL playground docs.

batch Ship To NY

The batchShipToNY mutation is used to initiate the shipping process to New York (NY) for a batch. It takes three parameters:
  • items ([batchGridInputItem]): Array of batchGridInputItem objects. Each batchGridInputItem represents an item within the batch that you want to update the status for.
  • approvedBy (String): Specifies the name of the person who approved or received the batch. It expects a string value representing the approver's name.
  • tracking (String): The tracking number associated with the shipment. enables tracking its progress.
  • Output: Boolean - if the update operation fails for any reason, it will return false.
          
mutation {
  batchShipToNY(items: [batchGridInputItem], approvedBy: String, tracking: String)
}
          
          
variables: {
  "items":[
      {
        "src": "JA",
        "orderID": 12345,
        "orderItemID": 1234567
      }
    ],
    "approvedBy": "john",
    "tracking": "688454100362"
}
 
          
       
you can add any field from order schema that you find in graphiQL playground docs.

bachLog PrintOrder

bachLogPrintOrder - set batch of order ids as printed
  • orderIDs ([Int!]!): Array of order ids
          
mutation {
  bachLogPrintOrder(orderIDs: [Int!]!)
}
          
       
you can add any field from order schema that you find in graphiQL playground docs.

mailbox/v/1

https://jxnet-api.services.r2net.com/mailbox/v/1/

Get Mailbox

The getMailbox query allows you to retrieve a list of mailboxes based on specified criteria. It takes three parameters:
  • tab (String): This parameter represents the tab of mailboxes you want to retrieve. It expects a string value that corresponds to a specific tab or category in the mailbox system. By specifying a tab, you can filter the results to only include mailboxes that belong to that tab.
  • pageSize (Int): Maximum number of mailboxes to be returned per page. The system will return mailboxes in chunks or pages, with each page containing up to the specified number of mailboxes.
  • pageNumber (Int): Page number of the mailboxes you want to retrieve. By providing the page number, you can navigate through the paginated results and retrieve mailboxes from specific pages.
tabs values: inbox, SentItems, DeletedItems
          
{
  getMailbox(tab: String, pageSize: Int, pageNumber: Int) {
    src
    msgCount
    pageCount
    messages {
      msgID
      read
      date
      msgText
      orderID
      customer
      myID
      sender
      senderID
      recipients {
        id
        name
        read
      }
    }
  }
}
          
          
variables:  {
  "tab": "inbox",
  "pageSize": 20,
  "pageNumber": 1
}
          
         
        
you can add any field from order schema that you find in graphiQL playground docs.

Get Order Msgs

The getOrderMsgs query allows you to retrieve a list of messages associated with a specific order. It takes one parameter:
  • Input: id: ID! - The unique identifier of the order
          
{
    getOrderMsgs(orderID: Int) {
      msgID
      read
      orderID
      date
      msgText
      customer
      myID
      sender
      senderID
      recipients {
        id
        name
        read
      }
    }
}
          
        
you can add any field from order schema that you find in graphiQL playground docs.

Get Contact List

The getContactList query allows you to retrieve a list of contacts from a contact list or address book. It does not require any parameters.
          
{
    getContactList {
      userID
      displayName
    }
}
          
        
you can add any field from order schema that you find in graphiQL playground docs.

Send Msg

The sendMsg mutation is used to send a message to one or more recipients. It takes three parameters:
  • recipientIDs ([Int!]!): Array of IDs of the recipients you want to send the message to.
  • orderID (Int): orderID associated with the message.
  • msgText (String!): The message you want to send.
          
mutation {
    sendMsg (recipientIDs: String!, orderID: $orderID, msgText: $msgText)
}
          
        
you can add any field from order schema that you find in graphiQL playground docs.