Skip to main content
GET
/
quickbooks-desktop
/
shipping-methods
/
{id}
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

const shippingMethod = await conductor.qbd.shippingMethods.retrieve('80000001-1234567890', {
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(shippingMethod.id);
{
  "id": "80000001-1234567890",
  "objectType": "qbd_shipping_method",
  "createdAt": "2025-01-01T12:34:56.000Z",
  "updatedAt": "2025-02-01T12:34:56.000Z",
  "revisionNumber": "1721172183",
  "name": "FedEx Ground",
  "isActive": true
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the shipping method to retrieve.

Example:

"80000001-1234567890"

Response

200 - application/json

Returns the specified shipping method.

​
id
string
required

The unique identifier assigned by QuickBooks to this shipping method. This ID is unique across all shipping methods but not across different QuickBooks object types.

Example:

"80000001-1234567890"

​
objectType
string
required

The type of object. This value is always "qbd_shipping_method".

Allowed value: "qbd_shipping_method"
Example:

"qbd_shipping_method"

​
createdAt
string
required

The date and time when this shipping method was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-01-01T12:34:56.000Z"

​
updatedAt
string
required

The date and time when this shipping method was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-02-01T12:34:56.000Z"

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this shipping method object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

Example:

"1721172183"

​
name
string
required

The case-insensitive unique name of this shipping method, unique across all shipping methods.

NOTE: Shipping methods do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

Example:

"FedEx Ground"

​
isActive
boolean
required

Indicates whether this shipping method is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true