Shipping methods

A shipping method is a specific way to transport goods, such as UPS or FedEx.

List shipping methods

get/objects/accounts-receivable/shipping-method

Returns a collection with a key, ID, and link for each shipping method. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "Ground",
      • "href": "/objects/accounts-receivable/shipping-method/1"
      },
    • {
      • "key": "2",
      • "id": "Air",
      • "href": "/objects/accounts-receivable/shipping-method/2"
      },
    • {
      • "key": "3",
      • "id": "Fedex",
      • "href": "/objects/accounts-receivable/shipping-method/3"
      },
    • {
      • "key": "4",
      • "id": "Sea Route",
      • "href": "/objects/accounts-receivable/shipping-method/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a shipping method
post/objects/accounts-receivable/shipping-method
Creates a new shipping method object.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Name or other unique ID for the shipping method.


 
 Example:  "Air"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
daysInTransit
integer
Estimated number of days to ship goods from the warehouse to the customer. The value in this field is used to calculate the ship by date in Order Entry transactions. The ship by date is calculated based on the need by date minus the estimated days in transit.


 
 Example:  10
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Air",
  • "daysInTransit": 10
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "2",
    • "id": "2",
    • "href": "/objects/accounts-receivable/shipping-method/2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a shipping method
get/objects/accounts-receivable/shipping-method/{key}
Returns detailed information for a specified shipping method.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the shipping method.


 
 Example:  2
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "2",
    • "id": "Air",
    • "status": "active",
    • "daysInTransit": 4,
    • "href": "/objects/accounts-receivable/shipping-method/2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a shipping method
patch/objects/accounts-receivable/shipping-method/{key}
Updates an existing shipping method by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the shipping method.


 
 Example:  2
Request Body schema: application/json
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
daysInTransit
integer
Estimated number of days to ship goods from the warehouse to the customer. The value in this field is used to calculate the ship by date in Order Entry transactions. The ship by date is calculated based on the need by date minus the estimated days in transit.


 
 Example:  10
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "daysInTransit": 15
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "2",
    • "id": "2",
    • "href": "/objects/accounts-receivable/shipping-method/2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a shipping method
delete/objects/accounts-receivable/shipping-method/{key}
Deletes a shipping method.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the shipping method.


 
 Example:  2
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}