CREST
The CORESense REST API allows users of CORESense products to perform simple interactions with their data.
Changes
See the changelog for a description of the latest changes.
REST
CREST attempts to adhere to REST practices as closely as possible. HTTP methods like GET, POST, PUT, and DELETE are used to issue requests to resource-based URIs. The response will always have a significant HTTP status and (where applicable) a JSON-formatted payload. GET requests will always be read-only. PUT requests change existing records. POST requests add new records. DELETE requests remove existing records.
Authentication
Authentication is provided via JSON Web Tokens. All requests must include a valid, signed, non-expired token. This may be provided via either of the following request headers:
X-Auth-Token: <token>
Authorization: Bearer <token>The JWT header must include the following keys:
- “alg”: The algorithm used to sign the token.
The following signature types are supported:
-
HS256
-
HS384
-
HS512
-
RS256
-
RS384
-
RS512
The JWT payload must include the following keys:
-
“sub” : Your CORESense-provided API user id.
-
“exp” : An expiration timestamp not more than one day in the future.
Example PHP code to generate a token with an HMAC/SHA signature:
<?php
$myUserId = '<your CORESense-provided user id>';
$mySignKey = '<your CORESense-provided sign key>';
$header = [
'alg' => 'HS256',
];
$payload = [
'sub' => $myUserId,
'exp' => time() + 3600,
];
$t1 = base64_url_encode(json_encode($header));
$t2 = base64_url_encode(json_encode($payload));
$signature = hash_hmac('sha256', $t1 . '.' . $t2, $mySignKey, true);
$t3 = base64_url_encode($signature);
$token = $t1 . '.' . $t2 . '.' . $t3;Example PHP code to generate a token with an RSA/SHA signature:
<?php
$myUserId = '<your CORESense-provided user id>';
$mySignKey = '<your PEM-formatted private key>';
$header = [
'alg' => 'RS256',
];
$payload = [
'sub' => $myUserId,
'exp' => time() + 3600,
];
$t1 = base64_url_encode(json_encode($header));
$t2 = base64_url_encode(json_encode($payload));
openssl_sign($t1 . '.' . $t2, $signature, $mySignKey, 'sha256');
$t3 = base64_url_encode($signature);
$token = $t1 . '.' . $t2 . '.' . $t3;Please note that the BASE64 encoding used for JWT is not the commonly used RFC-4648 style, but the URL-friendly RFC-7515 style.
Pagination
Unless otherwise specified, GET endpoints which return sets of records will be paginated. That is, they will not necessarily include the entire result set, rather a subset of it. To obtain the full set, you may have to iterate through multiple pages of results.
Query Parameters
page_size
The query parameter page_size may be used to set the number of records per page. If not specified, a default value
of 10 will be used. The maximum value supported is 100.
page
The query parameter page may be used to request a specific page. The value is 1-based. If not specified, the first
page will be returned.
Headers
Result sets that are paginated may contain pagination metadata headers. Because including these headers may
significantly increase the amount of time required to generate the result, they are excluded by default. They may be
included by specifying the X-Pagination-Hints: 1 header in the request. In this case, the following headers will be
included in the result.
X-Record-Count: <integer>
Indicates the total number of records in the result set.
X-Page-Count: <integer>
Indicates the total number of pages in the result set. This is based on current page size.
X-Page-Size: <integer>
The current page size being used.
X-Page-Number: <integer>
The page number that this result set represents.
Link: <string>
Up to four links will be included in the link header as per RFC5988. These will provide URLs for the first, previous, next, and last pages, where appropriate.
Field Limiting
By default, GET endpoints will return all the fields available for a record. You may limit the result set to an arbitrary
subset of these fields. This is done via the fields parameter:
GET /v1/product?fields=part_num
You may request more than one field by separating them with commas:
GET /v1/product?fields=id,part_num,base_price
Each field may include regular expressions. For example:
GET /v1/product?fields=id,part_num,base_price,custom_.*
Note that you may have to hex encode the string if it contains special characters.
Filtering
Unless otherwise specified, GET endpoints which return sets of records support filtering by an arbitrary list of field
values. Query filters are specified via the q parameter and have the following format:
<field><operator><value>
The following operators are supported:
-
= -
!= -
< -
<= -
> -
>=
For example, to get all products:
GET /v1/product
To get all products of a certain product type:
GET /v1/product?q=type=3
You may specify more than one filter by using multiple q parameters with array syntax. All such specified filters are
grouped via the AND operator. For example, to get all products with a base price between $5.00 and $10.00:
GET /v1/product?q[]=base_price>=5&q[]=base_price<=10
Filtering on Date / Time Fields
Database fields that include time in their native storage (such as models.last_modified_timestamp or inventory.stamp)
can be queried for date alone or date + time. If queried for date alone, time is presumed to be midnight. Database
fields that do not include time in their native storage (such as order_items.delivery_date) can only be queried by
date. Date and time parameters can be formatted in virtually any reasonable manner but note that formats like
mm/dd/yy should not be used because they are ambiguous in cases like 01/02/03.
Filtering by Date Only
In this case, the time will default to the midnight at the start of the day indicated, and the timezone will default to the existing timezone setting for your installation.
/v1/product?q=last_modified_stamp>=2018-01-01
Filtering by Date + Time
In this case, the timezone will default to the existing timezone setting for your installation.
/v1/product?q=last_modified_stamp>=2018-01-01T14:30:00
Filtering by Date + Time + Timezone (ISO 8601)
This is the format that the API presents timestamps in.
/v1/product?q=last_modified_stamp>=2018-01-01T14:30:00-05:00
Filtering by Relative Time
To reference a time relative to when the API call is made, you may supply a string that describes the difference, in
the format <sign><integer><time period>. For example, -1day or +2months.
/v1/product?q=last_modified_stamp>=-4hours
/v1/skuInventory?q=movement_date>=-2days
Sorting
Unless otherwise specified, GET endpoints which return sets of records support ordering by certain user-specified
fields. This is performed via the order parameter. For example:
GET /v1/product?order=part_num
The order may be reversed by preceeding the field name with -:
GET /v1/product?order=-part_num
Note that not every field available in a record may be sorted on. See the individual endpoint docs for details about which fields may be used for that endpoint.
Example Requests
GET
GET requests have no payload and may include optional query parameters.
<?php
$token = '...'; // see above
$curl = curl_init(
'https://api-foo.coresense.com/v1/category?' .
http_build_query([
'page_size' => 5,
'fields' => 'id,category',
])
);
curl_setopt_array($curl, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-Auth-Token: ' . $token]
]);
$result = curl_exec($curl);
curl_close($curl);
if ($result !== false) {
$data = json_decode($result, true);
print_r($data);
}PUT
PUT requests have a JSON-encoded payload and typically return a 204 status with no body.
$token = '...';
$data = json_encode([
'status' => 'new',
'ship_date' => '2018-01-02',
]);
$curl = curl_init('https://api-foo.coresense.com/v1/shipment/12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-Auth-Token: ' . $token,
'Content-Type: application/json',
'Content-Length: ' . strlen($data),
],
CURLOPT_POSTFIELDS => $data,
]);
$result = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status === 204) {
// success
}POST
POST requests have a JSON-encoded payload and typically return a 201 status with a body including the id of the record that was just created.
$token = '...';
$data = json_encode([
'category' => 'foo',
'label' => 'bar',
'active' => false,
]);
$curl = curl_init('http://localhost:8080/v1/category');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-Auth-Token: ' . $token,
'Content-Type: application/json',
'Content-Length: ' . strlen($data),
],
CURLOPT_POSTFIELDS => $data,
]);
$result = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status === 201) {
print_r(json_decode($result, true));
}More detailed examples may be found on our GitHub repository.
Rate Limiting
If rate limiting is enabled, requests may fail due to excessive use. In this case, the response will have a status of
429 Too Many Requests. If the request was denied because the number of requests exceeded the allowed limit, the
response will include the following headers:
X-RateLimit-Hits: <maximum number of hits allowed per time period>
Retry-After: <timestamp for the earliest possible retry>If the request was denied because the number of bytes exceeded the allowed limit, the response will include the following headers:
X-RateLimit-Bytes: <maximum number of bytes allowed per time period>
Retry-After: <timestamp for the earliest possible retry>Caching
If the request was served from a cache, the response will include the X-Cached: 1 header.
Resources
The following resource endpoints are available.
Affiliate ¶
Affiliate ¶
A affiliate.
Headers
Content-Type: application/jsonBody
{
"active": true,
"address1": "",
"address2": "",
"city": "",
"commission_rate_id": 0,
"company_name": "",
"contact_first_name": "",
"contact_last_name": "",
"country_id": 0,
"email": "",
"fax": "1234567890",
"id": 2,
"password": "",
"payment_notification_template_id": 0,
"phone": "",
"sale_notification": 0,
"sale_notification_template_id": 0,
"state_id": 0,
"url": "",
"username": "",
"zip": ""
}Retrieve a affiliateGET/v1/affiliate/{affiliate_id}
Returns a specific affiliate.
- affiliate_id
integer(required) Example: 123The id of the affiliate.
Affiliate Collection ¶
A collection of affiliates.
Body
[
{
"active": true,
"address1": "",
"address2": "",
...
},
{
"active": true,
"address1": "",
"address2": "",
...
},
...
]Retrieve all affiliatesGET/v1/affiliate{?order}
Retrieves all affiliates.
- order
string(optional) Default: id Example: usernameThe field to sort the result set by. Prefix with
-to invert.Choices:
commission_rate_ididusername
Barcode ¶
Barcode ¶
A barcode.
Headers
Content-Type: application/jsonBody
{
"barcode": "ABCDE12345",
"id": 2345,
"product_id": 123,
"stamp": "2009-12-11T08:27:57-05:00"
}Retrieve a barcodeGET/v1/barcode/{barcode_id}
Returns a specific barcode.
- barcode_id
integer(required) Example: 123The id of the barcode.
Barcode Collection ¶
A collection of barcodes.
Body
[
{
"barcode": "ABCDE12345",
"id": 2345,
"product_id": 123,
...
},
{
"barcode": "ABCDE12346",
"id": 2346,
"product_id": 124,
...
},
...
]Retrieve all barcodesGET/v1/barcode{?order}
Retrieves all barcodes.
- order
string(optional) Default: id Example: product_idThe field to sort the result set by. Prefix with
-to invert.Choices:
barcodeidproduct_id
BarcodeSKU ¶
Barcode SKU ¶
A barcode SKU.
Headers
Content-Type: application/jsonBody
{
"barcode_id": 123,
"id": 1,
"quantity": 10,
"sku_id": 12345
}Retrieve a barcode SKUGET/v1/barcodeSku/{barcode_sku_id}
Returns a specific barcode SKU.
- barcode_sku_id
integer(required) Example: 123The id of the barcode SKU.
Barcode SKU Collection ¶
A collection of barcode SKUs.
Body
[
{
"barcode_id": 123,
"id": 1,
"quantity": 10,
...
},
{
"barcode_id": 123,
"id": 1,
"quantity": 10,
...
},
...
]Retrieve all barcode SKUsGET/v1/barcodeSku{?order}
Retrieves all barcode SKUs.
- order
string(optional) Default: id Example: sku_idThe field to sort the result set by. Prefix with
-to invert.Choices:
barcode_ididsku_id
Brand ¶
Brand ¶
A brand.
Headers
Content-Type: application/jsonBody
{
"custom_address": "Foo to the Bar",
"custom_company_name": "FooBar",
"custom_logo_url": "",
"custom_main_email_address": "",
"custom_main_fax": "",
"custom_main_phone": "",
"custom_payment_processor_statement_description": "",
"custom_web_site_url": "",
"fully_shipped_email_template": 0,
"id": 3,
"label": "foo",
"partially_shipped_email_template": 0,
"status": "active",
"website_gift_certificate_template": 0
}Retrieve a brandGET/v1/brand/{brand_id}
Returns a specific brand.
- brand_id
integer(required) Example: 123The id of the brand.
Brand Collection ¶
A collection of brands.
Body
[
{
"custom_address": "Foo to the Bar",
"custom_company_name": "FooBar",
"custom_logo_url": "",
...
},
{
"custom_address": "Foo to the Bar",
"custom_company_name": "FooBar",
"custom_logo_url": "",
...
},
...
]Retrieve all brandsGET/v1/brand{?order}
Retrieves all brands.
- order
string(optional) Default: id Example: statusThe field to sort the result set by. Prefix with
-to invert.Choices:
idstatus
Category ¶
Category ¶
A product category.
Body
{
"active": true,
"category": "root",
"custom_breadcrumb_parent": 0,
...
}Body
{
"id": "123",
"uri": "..."
}Create a CategoryPOST/v1/category/
Create a new category.
Headers
Content-Type: application/jsonBody
{
"active": true,
"category": "root",
"custom_breadcrumb_parent": 0,
"custom_header_html": "",
"custom_header_title": "",
"custom_position": 0,
"custom_thumbnail_image": "",
"default_product_type": 0,
"description": "",
"homepage_active": false,
"id": 1,
"label": "",
"meta_abstract": "",
"meta_description": "",
"meta_keywords": "",
"meta_title": "",
"page_title": "",
"powerreviews_active": true,
"root": false,
"website_display_name": ""
}Retrieve a CategoryGET/v1/category/{category_id}
Retrieve a specific category.
- category_id
integer(required) Example: 123The id of the category.
Update a CategoryPUT/v1/category/{category_id}
Update a specific category.
- category_id
integer(required) Example: 123The id of the category.
Delete a CategoryDELETE/v1/category/{category_id}
Delete a specific category.
- category_id
integer(required) Example: 123The id of the category.
Category Collection ¶
A collection of categories.
Body
[
{
"active": true,
"category": "root",
"custom_breadcrumb_parent": 0,
...
},
{
"active": true,
"category": "root",
"custom_breadcrumb_parent": 0,
...
},
...
]Retrieve all CategoriesGET/v1/category{?order}
Retrieve all categories.
- order
string(optional) Default: id Example: categoryThe field to sort the result set by. Prefix with
-to invert.Choices:
categoryidlabel
Category Product Collection ¶
A collection of products.
Body
[
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
...
]Retrieve all Category ProductsGET/v1/category/{category_id}/product{?order}
Retrieve all products in a category.
- category_id
integer(required) Example: 123The id of the category.
- order
string(optional) Default: id Example: part_numThe field to sort the result set by. Prefix with
-to invert.Choices:
idlast_modified_stampmanufacturer_idpart_numtype
Category Featured Product Collection ¶
A collection of products.
Body
[
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
...
]Retrieve all Category Featured ProductsGET/v1/category/{category_id}/channel/{channel_id}/featuredProduct{?order}
Retrieve all featured products in a category.
- category_id
integer(required) Example: 123The id of the category.
- channel_id
integer(required) Example: 456The id of the channel.
- order
string(optional) Default: id Example: part_numThe field to sort the result set by. Prefix with
-to invert.Choices:
idlast_modified_stampmanufacturer_idpart_numtype
Category Product Collection Per Channel ¶
A collection of products.
Body
[
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
...
]Retrieve all Category Products Per ChannelGET/v1/category/{category_id}/channel/{channel_id}/{?order}
Retrieve all products in a category for a particular channel.
- category_id
integer(required) Example: 123The id of the category.
- channel_id
integer(required) Example: 456The id of the channel.
- order
string(optional) Default: id Example: part_numThe field to sort the result set by. Prefix with
-to invert.Choices:
idlast_modified_stampmanufacturer_idpart_numtype
Category Subcategory Collection ¶
A collection of subcategories.
Body
[
{
"active": true,
"category": "root",
"custom_breadcrumb_parent": 0,
...
},
{
"active": true,
"category": "root",
"custom_breadcrumb_parent": 0,
...
},
...
]Retrieve all Category SubcategoriesGET/v1/category/{category_id}/subcategory{?order}
Retrieve all subcategories of a category.
- category_id
integer(required) Example: 123The id of the category.
- order
string(optional) Default: id Example: categoryThe field to sort the result set by. Prefix with
-to invert.Choices:
categoryidlabel
Body
{
"subcategory_id": 456
}Create a Sucbategory relationship from a CategoryPOST/v1/category/subcategory
Add a category as a subcategory of a specific a category.
Delete a Subcategory relationship from a CategoryDELETE/v1/category/{category_id}/subcategory
Remove a category as a subcategory for a specific category.
- category_id
integer(required) Example: 123The id of the category.
- subcategory_id
integer(required) Example: 456The id of the subcategory.
Category WebUrlOverride ¶
A WebUrlOverride for a category.
Headers
Content-Type: application/jsonBody
{
"id": 11112,
"interface_id": "1",
"assoc_entity": "Category",
"assoc_entity_id": "123",
"url": "mens-shoes",
"active": 1
}Retrieve the WebUrlOverride for a CategoryGET/v1/category/{category_id}/weburloverride/{channel_id}
Retrieve the WebUrlOverride for a Category on a specific channel.
- category_id
integer(required) Example: 123The id of the category.
- channel_id
integer(required) Example: 1The id of the channel.
Update a WebUrlOverride for a CategoryPUT/v1/category/{category_id}/weburloverride/{channel_id}
Update the WebUrlOverride for a Category on a specific channel.
- category_id
integer(required) Example: 123The id of the category.
- channel_id
integer(required) Example: 1The id of the channel.
- url
string(required) Example: mens-shoesThe url of the override.
Channel ¶
Channel ¶
A channel.
Headers
Content-Type: application/jsonBody
{
"access_level": 0,
"brand_id": 1,
"channel_type": "",
"data_table": "web_data",
"default_payment_processor_id": 0,
"icon_location": "images/www_icon.gif",
"id": 1,
"label": "Website",
"module_location": "channels/web_site/web_site_manager.php3",
"module_type": "internal",
"record_table": "",
"tax_exempt_allowed": false
}Retrieve a ChannelGET/v1/channel/{channel_id}
Returns a specific channel.
- channel_id
integer(required) Example: 123The id of the channel.
Channel Collection ¶
A collection of channels.
Body
[
{
"access_level": 0,
"brand_id": 1,
"channel_type": "",
...
},
{
"access_level": 0,
"brand_id": 1,
"channel_type": "",
...
},
...
]Retrieve all ChannelsGET/v1/channel{?order}
Retrieves all channels.
- order
string(optional) Default: id Example: labelThe field to sort the result set by. Prefix with
-to invert.Choices:
brand_ididlabel
Channel Product Collection ¶
A collection of products.
Body
[
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
...
]Retrieve all Channel ProductsGET/v1/channel/{channel_id}/product{?order}
Retrieve all products in a channel.
- channel_id
integer(required) Example: 123The id of the channel.
- order
string(optional) Default: id Example: part_numThe field to sort the result set by. Prefix with
-to invert.Choices:
idlast_modified_stampmanufacturer_idpart_numtype
Channel Shipment Collection ¶
A collection of shipments.
Body
[
{
"arrival_date": "",
"assoc_entity": "order",
"assoc_entity_id": 3,
...
},
{
"arrival_date": "",
"assoc_entity": "order",
"assoc_entity_id": 3,
...
},
...
]Retrieve all Channel ShipmentsGET/v1/channel/{channel_id}/shipment{?order}
Retrieve all shipments of orders in a channel.
- channel_id
integer(required) Example: 123The id of the channel.
- order
string(optional) Default: id Example: statusThe field to sort the result set by. Prefix with
-to invert.Choices:
idstatusexportedassoc_entity
Comment ¶
Body
{
"message": "Order has been cancelled.",
"rep": "coresense",
"stamp": "2019-09-23 15:34:05",
"type": "Other",
"assoc_entity": "order",
"assoc_entity_id": 19283,
"privacy": "private",
"code": 12
}Schema
{
"type": "object",
"properties": {
"message": {
"type": "string"
},
"rep": {
"type": "string",
"description": "Refers to existing username in system."
},
"stamp": {
"type": "string"
},
"type": {
"type": "string"
},
"assoc_entity": {
"type": "string"
},
"assoc_entity_id": {
"type": "number"
},
"privacy": {
"type": "string"
},
"code": {
"type": "number",
"description": "Empty or existing comment code."
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Body
{
"id": "123",
"uri": "..."
}Create a CommentPOST/v1/comment/
Create a new comment.
Headers
Content-Type: application/jsonBody
{
"assoc_entity": 'return',
"assoc_entity_id": 9,
"code": 0,
"id": 10,
"message": "Returned twice",
"privacy": "private",
"rep": "coresense",
"stamp": "2019-05-22T12:56:34-04:00",
"type": "Other",
}Retrieve a CommentGET/v1/comment/{comment_id}
Returns a specific comment.
- comment_id
integer(required) Example: 123The id of the comment.
Comment Collection ¶
A collection of comment.
Body
[
{
"assoc_entity": "customer",
"assoc_entity_id": 29382,
"code": 0,
...
},
{
"assoc_entity": "quote",
"assoc_entity_id": 52,
"code": 2,
...
},
...
]Retrieve all CommentsGET/v1/comment{?order}
Retrieves all comments.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
assoc_entityassoc_entity_idid
CommentCode ¶
Contact ¶
A comment code.
Body
{
"code": "CE",
"description": "Description of the code"
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Body
{
"id": "123",
"uri": "..."
}Create a CommentCodePOST/v1/commentCode/
Create a new comment code.
Headers
Content-Type: application/jsonBody
{
"id": 10,
"code": "OM",
"description": "Order Modification",
}Retrieve a CommentCodeGET/v1/commentCode/{comment_code_id}
Returns a specific comment code.
- comment_code_id
integer(required) Example: 123The id of the comment code.
Contact Collection ¶
A collection of comment codes.
Body
[
{
"id": 11,
"code": "OC",
"description": "Order Cancellation",
},
{
"id": 12,
"code": "BI",
"description": "Billing Issue",
},
...
]Retrieve all CommentCodesGET/v1/commentCode
Retrieves all comment codes.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.
Contact ¶
Contact ¶
A contact.
Body
{
"active": true,
"address_line_1": "123 Main St.",
"address_line_2": "Apt. 1A",
"business_phone": "123-456-7890",
"city": "Gotham",
"company": "Wayne Enterprises",
"country": "US",
"country_id": 1,
"customer_id": 1234,
"date_of_birth": "2017-12-12",
"email": "definitely_not_batman@waynecorp.com",
"fax": "123-456-7890",
"first_name": "Bruce",
"label": "work",
"last_name": "Wayne",
"phone": "123-456-7890",
"postal_code": "12345",
"requires_liftgate": true,
"residential_address": true,
"state": "NY",
"state_id": 12,
"verified": true
}Schema
{
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"address_line_1": {
"type": "string"
},
"address_line_2": {
"type": "string"
},
"business_phone": {
"type": "string"
},
"city": {
"type": "string"
},
"company": {
"type": "string"
},
"country": {
"type": "string",
"description": "If specified, omit `country_id` and we'll look up the appropriate value."
},
"country_id": {
"type": "number"
},
"customer_id": {
"type": "number",
"description": "Must refer to an existing customer."
},
"date_of_birth": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
},
"first_name": {
"type": "string"
},
"label": {
"type": "string"
},
"last_name": {
"type": "string"
},
"phone": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"requires_liftgate": {
"type": "boolean"
},
"residential_address": {
"type": "boolean"
},
"state": {
"type": "string",
"description": "If specified, omit `state_id` and we'll look up the appropriate value."
},
"state_id": {
"type": "number"
},
"verified": {
"type": "boolean"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Body
{
"id": "123",
"uri": "..."
}Create a ContactPOST/v1/contact/
Create a new contact.
Headers
Content-Type: application/jsonBody
{
"active": true,
"address_line_1": "",
"address_line_2": "",
"business_phone": "",
"city": "",
"company": "",
"country_id": 1,
"customer_id": 13,
"date_of_birth": "2017-12-12T11:35:02-05:00",
"email": "foo@bar.com",
"fax": "",
"first_name": "Foo",
"id": 10,
"label": null,
"last_name": "Bar",
"phone": "",
"postal_code": "",
"requires_liftgate": true,
"residential_address": false,
"state_id": 0,
"verified": false
}Retrieve a ContactGET/v1/contact/{contact_id}
Returns a specific contact.
- contact_id
integer(required) Example: 123The id of the contact.
Contact Collection ¶
A collection of contacts.
Body
[
{
"active": true,
"address_line_1": "",
"address_line_2": "",
...
},
{
"active": true,
"address_line_1": "",
"address_line_2": "",
...
},
...
]Retrieve all ContactsGET/v1/contact{?order}
Retrieves all contacts.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
activecustomer_idemailfirst_nameidlast_namephonepostal_codestate_id
Country ¶
Country ¶
A country.
Headers
Content-Type: application/jsonBody
{
"code_iso_alpha_2": "US",
"code_iso_alpha_3": "USA",
"code_un_numeric": "840",
"country": "United States",
"id": 1
}Retrieve a CountryGET/v1/country/{country_id}
Returns a specific country.
- country_id
integer(required) Example: 123The id of the country.
Country Collection ¶
A collection of countries.
Body
[
{
"code_iso_alpha_2": "US",
"code_iso_alpha_3": "USA",
"code_un_numeric": "840",
...
},
{
"code_iso_alpha_2": "CA",
"code_iso_alpha_3": "CAN",
"code_un_numeric": "124",
...
},
...
]Retrieve all CountriesGET/v1/country{?order}
Retrieves all countries.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
code_iso_alpha_2id
Customer ¶
Customer ¶
A customer. Note that the primary key field in the JSON response packet for this resource is named client_id and
not id as for most other resources.
Body
{
"affiliate_id": 1,
"customer_tier_id": 1,
"default_billing_contact_id": 1,
"default_shipping_contact_id": 1,
"last_key_code": "Hello, world!",
"originating_brand_id": 1,
"source_code": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"affiliate_id": {
"type": "number"
},
"customer_tier_id": {
"type": "number"
},
"default_billing_contact_id": {
"type": "number"
},
"default_shipping_contact_id": {
"type": "number"
},
"last_key_code": {
"type": "string"
},
"originating_brand_id": {
"type": "number"
},
"source_code": {
"type": "string"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Body
{
"id": "123",
"uri": "..."
}Create a CustomerPOST/v1/customer/
Create a new customer.
Rather than specifying existing values for default_billing_contact_id and default_shipping_contact_id, you may omit
them and instead provide default_billing_contact and default_shipping_contact as a Contact key/value set, as
follows:
{
"originating_brand_id": 2,
"affiliate_id": 3,
"default_billing_contact": {
"address_line_1": "1 Main St",
"city": "London",
"email": "foo@bar.com",
"first_name": "Joe",
"label": "home",
"last_name": "Smith",
"state": "NY"
},
"default_shipping_contact": {
"address_line_1": "37 Elm St",
"city": "Paris",
"email": "foo@bar.com",
"first_name": "Joe",
"label": "work",
"last_name": "Smith",
"state": "NY"
}
}Headers
Content-Type: application/jsonBody
{
"affiliate_id": 0,
"client_id": 10,
"currency_rate": "USD",
"custom_account_manager": 0,
"custom_attend_a_pop_trunk_show": "no",
"custom_box_number": "",
"custom_customer_type": ",2,1,",
"custom_default_payment_type": 0,
"custom_guest_shopper": false,
"custom_host_a_pop_trunk_show": "no",
"custom_school_address2": null,
"custom_send_news_and_promotions": "no",
"custom_wishlist_temp_order_num": 0,
"customer_billing_exported": false,
"customer_shipping_exported": false,
"customer_tier_id": 0,
"default_billing_contact_id": 7,
"default_preorder_contact_id": 0,
"default_shipping_contact_id": 7,
"employee_number": "",
"last_key_code": "",
"last_modified": "",
"originating_brand_id": 0,
"product_upsell_last_sent": "",
"source_code": "",
"stamp": "2009-03-03T06:55:33-05:00"
}Retrieve a CustomerGET/v1/customer/{customer_id}
Returns a specific customer.
- customer_id
integer(required) Example: 123The id of the customer.
Customer Collection ¶
A collection of customers.
Body
[
{
"affiliate_id": 0,
"client_id": 10,
"currency_rate": "USD",
...
},
{
"affiliate_id": 0,
"client_id": 10,
"currency_rate": "USD",
...
},
...
]Retrieve all CustomersGET/v1/customer{?order}
Retrieves all customers.
- order
string(optional) Default: client_id Example: client_idThe field to sort the result set by. Prefix with
-to invert.Choices:
client_idoriginating_brand_iddefault_billing_contact_iddefault_shipping_contact_id
Customer Contact Collection ¶
A collection of customer contacts.
Body
[
{
"active": true,
"address_line_1": "",
"address_line_2": "",
...
},
{
"active": true,
"address_line_1": "",
"address_line_2": "",
...
},
...
]Retrieve all contacts for a customerGET/v1/customer/{customer_id}/contact{?order}
Retrieves all active contacts for a customer.
- customer_id
integer(required) Example: 123The id of the customer.
- order
string(optional) Default: id Example: state_idThe field to sort the result set by. Prefix with
-to invert.Choices:
activecustomer_idemailfirst_nameidlast_namephonepostal_codestate_id
CreditCard ¶
CreditCard ¶
A credit card.
Body
{
"client_id": "38271",
"cardholder_first_name": "CORESense",
"cardholder_last_name": "Company",
"card_num": "4111111111111111",
"expiration_month": "02",
"expiration_year": "2020",
"payment_type_id": "1",
"receivable_type_id": "3",
"payment_processor_id": "3",
"token": "4321evn8ewnD"
}Body
{
"id: "123"
}Create a CreditCardPOST/v1/creditCard/
Create a new credit card.
Headers
Content-Type: application/jsonBody
{
"id": "123",
"client_id": "47382",
"cardholder_first_name": "CORESense",
"cardholder_last_name": "Company",
"card_num": "4111111111111111",
"exp_date": "2020-02-29",
"payment_type_id": 1,
"receivable_type_id": 3,
"stamp": "2019-06-27 19:03:01",
"active": "y",
}Retrieve a CreditCardGET/v1/creditCard/
Returns a specific credit card.
- id
integer(required) Example: 123The id of the credit card.
CreditCardToken ¶
Affiliate ¶
A credit card token.
Headers
Content-Type: application/jsonBody
{
"credit_card_id": 5,
"id": 2,
"payment_processor_id": "1",
"stamp": 2019-08-08T13:57:30-04:00,
"token": "4839c4wmfsdms",
"token_type": "",
"token_provider": 0
}Retrieve a credit card tokenGET/v1/creditCardToken/{credit_card_token_id}
Returns a specific credit card token.
- credit_card_token_id
integer(required) Example: 123The id of the credit card token.
CreditCardToken Collection ¶
A collection of credit card tokens.
Body
[
{
"credit_card_id": "48372",
"id": "4",
"payment_processor_id": "20",
...
},
{
"credit_card_id": "48372",
"id": "483",
"payment_processor_id": "3",
...
},
...
]Retrieve all credit card tokensGET/v1/creditCardToken{?order}
Retrieves all credit_card_tokens.
- order
string(optional) Default: credit_card_token_id Example: credit_card_token_idThe field to sort the result set by. Prefix with
-to invert.Choices:
credit_card_idpayment_processor_id
Deal ¶
Deal ¶
A deal.
Headers
Content-Type: application/jsonBody
{
"active": 1,
"coupon_activated": 1,
"end": 2019-12-03T16:44:47-05:00,
"exclusive": "",
"id": 10,
"label": "Temp Test Deal",
"message": "",
"recurring_order": "",
"round": "Down",
"single_use": "",
"start": 2019-12-03T16:44:47-05:00,
"timestamp": 2011-06-02T11:38:33-04:00,
"type": "Promotional Discount",
}Retrieve a DealGET/v1/deal/{deal_id}
Returns a specific deal.
- deal_id
integer(required) Example: 123The id of the deal.
Deal Collection ¶
A collection of deals.
Body
[
{
"active": "",
"coupon_activated": "",
...
},
{
"active": 1,
"coupon_activated": 1,
...
},
...
]Retrieve all DealsGET/v1/deal{?order}
Retrieves all deals.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
activetypecoupon_activatedid
DealCouponCode ¶
DealCouponCode ¶
A deal’s coupon code.
Headers
Content-Type: application/jsonBody
{
"coupon_code": "test",
"deal_id": 32,
"id": 123,
}Retrieve a DealCouponCodeGET/v1/dealCouponCode/
Returns a specific deal coupon code.
- deal_id
integer(required) Example: 123The id of the deal coupon code.
DealCouponCode Collection ¶
A collection of deal coupon codes.
Body
[
{
"coupon_code": "CBSALE",
"deal_id": 392,
...
},
{
"coupon_code": "NovemberSale",
"deal_id": 493,
...
},
...
]Retrieve all DealCouponCodesGET/v1/dealCouponCode{?order}
Retrieves all deal coupon codes.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
deal_idcoupon_codeid
Help ¶
Error Code Collection ¶
A collection of error codes.
Body
[
{
"code": "100",
"name": "ERROR_INVALID_SHORTNAME",
"source": "\\Coresense\\Rest\\Middleware::ShortName"
},
{
"code": "200",
"name": "ERROR_TEMP_DIR_DOES_NOT_EXIST",
"source": "\\Coresense\\Rest\\Middleware::TempDir"
},
]Retrieve all Error CodesGET/v1/help/errorCode
Retrieves all error codes.
Ping ¶
A status end point.
Body
{
"timestamp": "2017-11-17T16:53:13-05:00"
}Ping the APIGET/v1/help/ping
Pings the API to verify status. Can be used to check authentication credentials.
Route Collection ¶
A collection of API routes.
Body
[
"GET \/v1\/category",
"GET \/v1\/category\/{category_id}",
"GET \/v1\/category\/{category_id}\/channel\/{channel_id}\/featuredProduct",
"GET \/v1\/category\/{category_id}\/product",
...
]Retrieve all RoutesGET/v1/help/route
Retrieves all currently available API routes.
Inventory ¶
Inventory ¶
A unit of inventory.
Headers
Content-Type: application/jsonBody
{
"assoc_entity": "ordered item",
"assoc_entity_id": 1234,
"build_type": "INV",
"cogs": 1.23,
"description": "a super thing",
"id": 1,
"inventory_id": 1,
"inventory_location_id": 0,
"manufacturer_id": 1,
"pos_order_num": 0,
"shipping_depth": 0,
"shipping_height": 0,
"shipping_weight": 0.5,
"shipping_width": 0,
"stamp": "2009-02-26T06:21:43-05:00",
"status": "assigned",
"vendor_id": 1,
"warehouse_id": 1
}Retrieve a Unit of InventoryGET/v1/inventory/{inventory_id}
Returns a specific unit of inventory.
- inventory_id
integer(required) Example: 123The id of the unit of inventory.
Inventory Collection ¶
A collection of units of inventory.
Body
[
{
"assoc_entity": "ordered item",
"assoc_entity_id": 1234,
"build_type": "INV",
...
},
{
"assoc_entity": "ordered item",
"assoc_entity_id": 1234,
"build_type": "INV",
...
},
...
]Retrieve all Inventory UnitsGET/v1/inventory{?order}
Retrieves all units of inventory.
- order
string(optional) Default: id Example: warehouse_idThe field to sort the result set by. Prefix with
-to invert.Choices:
idinventory_idinventory_location_idstatuswarehouse_id
Location ¶
Location ¶
A location.
Headers
Content-Type: application/jsonBody
{
"active": true,
"available_for_fulfillment": true,
"description": "",
"height": 0,
"id": 1,
"inventory_location_type_id": 1,
"is_distribution_staging": false,
"label": "01",
"length": 0,
"parent_id": 0,
"stamp": "",
"warehouse_id": 1,
"width": 0
}Retrieve a LocationGET/v1/location/{location_id}
Returns a specific location.
- location_id
integer(required) Example: 123The id of the location.
Location Collection ¶
A collection of locations.
Body
[
{
"active": true,
"available_for_fulfillment": true,
"description": "",
...
},
{
"active": true,
"available_for_fulfillment": true,
"description": "",
...
},
...
]Retrieve all LocationsGET/v1/location{?order}
Retrieves all locations.
- order
string(optional) Default: id Example: warehouse_idThe field to sort the result set by. Prefix with
-to invert.Choices:
idparent_idwarehouse_id
LocationType ¶
LocationType ¶
A location type.
Headers
Content-Type: application/jsonBody
{
"depth": 0,
"description": "",
"height": 0,
"id": 3,
"label": "Shelf",
"warehouse_id": 1,
"width": 0
}Retrieve a Location TypeGET/v1/locationType/{location_type_id}
Returns a specific location type.
- location_type_id
integer(required) Example: 123The id of the location type.
LocationType Collection ¶
A collection of location types.
Body
[
{
"depth": 0,
"description": "",
"height": 0,
...
},
{
"depth": 0,
"description": "",
"height": 0,
...
},
...
]Retrieve all Location TypesGET/v1/locationType{?order}
Retrieves all location types.
- order
string(optional) Default: id Example: warehouse_idThe field to sort the result set by. Prefix with
-to invert.Choices:
idwarehouse_id
Location Hierarchy ¶
Location Hierarchies ¶
Location Hierarchies.
Headers
Content-Type: application/jsonBody
[
{
id: 1,
location_type_hierarchy_type_id: 1,
label: “CORESense”,
parent_id: 0
}
…
{
id: 2,
location_type_hierarchy_type_id: 2,
label: “Northeast”,
parent_id: 9
}
]Retrieve Location HierarchiesGET/v1/location_hierarchies
Returns all location Hierarchies.
Location Hierarchy Types ¶
Location Hierarchy Types ¶
Location Hierarchy Types.
Headers
Content-Type: application/jsonBody
[
{
id: 1,
level: 1
label: “Chain”,
}
…
{
id: 1,
level: 1
label: “Chain”,
}
]Retrieve Location Hierarchy typeGET/v1/location_hierarchy_types
Returns all location Hierarchy types.
Manufacturer ¶
Manufacturer ¶
A manufacturer.
Headers
Content-Type: application/jsonBody
{
"id": 1,
"name": "Joe's Deli",
"stamp": "2017-01-09T15:59:47-05:00"
}Retrieve a manufacturerGET/v1/manufacturer/{manufacturer_id}
Returns a specific manufacturer.
- manufacturer_id
integer(required) Example: 123The id of the manufacturer.
Manufacturer Collection ¶
A collection of manufacturers.
Body
[
{
"id": 1,
"name": "Joe's Deli",
"stamp": "2017-01-09T15:59:47-05:00"
},
{
"id": 2,
"name": "Pizza Palace",
"stamp": "2017-02-13T01:05:17-05:00"
},
...
]Retrieve all manufacturersGET/v1/manufacturer{?order}
Retrieves all manufacturers.
- order
string(optional) Default: id Example: nameThe field to sort the result set by. Prefix with
-to invert.Choices:
idname
Master Purchase Order ¶
Master Purchase Orders ¶
Headers
Content-Type: application/jsonBody
{
"saved_purchase_order_id": 500044
}Create a Master Purchase OrderPOST/v1/masterPurchaseOrder
Create a Master Purchase Order from specific Saved Purchase Order.
- saved_purchase_order_id
integer(required) Example: 123Saved Purchase Order ID
Get merchandiseHierarchies Data ¶
Headers
Content-Type: application/jsonBody
[
{
"google_product_category": "187",
"id": "1",
"label": "001 Mens Work Boots",
"merchandise_hierarchy_type_id": "1",
"parent_id": "0",
"tax_code": null
},
{
"google_product_category": null,
"id": "2",
"label": "100 Safety Toe Athletic",
"merchandise_hierarchy_type_id": "2",
"parent_id": "1",
"tax_code": null
},
{
"google_product_category": null,
"id": "3",
"label": "101 Safety Toe Trail - Hiker",
"merchandise_hierarchy_type_id": "2",
"parent_id": "1",
"tax_code": null
},
{
"google_product_category": null,
"id": "4",
"label": "102 Safety Toe Oxford",
"merchandise_hierarchy_type_id": "2",
"parent_id": "1",
"tax_code": null
},
{
"google_product_category": null,
"id": "5",
"label": "103 Safety Toe Chukka",
"merchandise_hierarchy_type_id": "2",
"parent_id": "1",
"tax_code": null
},
{
"google_product_category": null,
"id": "6",
"label": "104 Safety Toe 5-6\" Boot",
"merchandise_hierarchy_type_id": "2",
"parent_id": "1",
"tax_code": null
},
{
"google_product_category": null,
"id": "7",
"label": "105 Safety Toe 7-8\" Boot",
"merchandise_hierarchy_type_id": "2",
"parent_id": "1",
"tax_code": null
}
]Retrieve all merchandiseHierarchiesGET/v1/merchandiseHierarchies
Retrieve all merchendies entries.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
id
Model Stock ¶
Model Stocks ¶
A collection of model stocks.
Headers
Content-Type: application/jsonBody
[
{
"active": true,
"default_vendor_id": 1,
"grid_id": 0,
"id": 1,
"label": null,
"medium": "document",
"medium_id": 1,
"model_id": 1,
"type": "up-to",
"use_distribution_center": false
},
...
]Retrieve all Model StocksGET/v1/modelStock
Retrieves all model stocks.
Headers
Content-Type: application/jsonBody
{
"active": true,
"default_vendor_id": 1,
"grid_id": 1,
"label": "model stock",
"medium": "document",
"medium_id": 1,
"model_id": 1,
"type": "fixed",
"use_distribution_center": true
}Headers
Content-Type: application/jsonBody
{
"id": "123"
}Create Model StockPOST/v1/modelStock
Creates a model stock.
- active
boolean(required) Example: trueIs active?
- default_vendor_id
integer(required) Example: 123Default vendor ID
- grid_id
integer(required) Example: 123Grid ID
- label
string(required) Example: model stockLabel
- medium
"document","email"(required) Example: Document- medium_id
integer(required) Example: 123- model_id
integer(required) Example: 123Model ID (SKU)
- type
"up-to","fixed"(required) Example: FixedType
- use_distribution_center
boolean(required) Example: trueDoes use istribution center?
Model Stock ¶
A model stock.
Headers
Content-Type: application/jsonBody
{
"active": true,
"default_vendor_id": 1,
"grid_id": 0,
"id": 1,
"label": null,
"medium": "document",
"medium_id": 1,
"model_id": 1,
"type": "up-to",
"use_distribution_center": false
}Retrieve a Model StockGET/v1/modelStock/{model_stock_id}
Returns a specific model stock.
- model_stock_id
integer(required) Example: 123The id of the model stock.
Headers
Content-Type: application/jsonBody
{
"active": true,
"default_vendor_id": 1,
"grid_id": 1,
"label": "model stock",
"medium": "document",
"medium_id": 1,
"model_id": 1,
"type": "fixed",
"use_distribution_center": true
}Update Model StockPUT/v1/modelStock/{model_stock_id}
Update a model stock.
- model_stock_id
integer(required) Example: 123The id of the model stock.
Delete a Model StockDELETE/v1/modelStock/{model_stock_id}
Delete a specific model stock. Deleting a model stock will result in deletion of associated Model Stock Levels and Model Stock Locations.
- model_stock_id
integer(required) Example: 123The id of the model stock.
Model Stock Levels ¶
Model Stock Levels ¶
A collection of model stock levels.
Headers
Content-Type: application/jsonBody
[
{
"id": 5,
"inventory_type_id": 16,
"model_stock_id": 5,
"quantity": 2,
"reorder_point": 1
},
...
]Retrieve all Model Stock LevelsGET/v1/modelStockLevel
Retrieves all model stock levels.
Headers
Content-Type: application/jsonBody
{
"inventory_type_id": 16,
"model_stock_id": 5,
"quantity": 2,
"reorder_point": 1
}Headers
Content-Type: application/jsonBody
{
"id": "123"
}Create Model Stock LevelPOST/v1/modelStockLevel
Creates a model stock level.
- inventory_type_id
integer(required) Example: 123Inventory type ID (SKU)
- model_stock_id
integer(required) Example: 123Model stock ID
- quantity
integer(required) Example: 50Quantity
- reorder_point
integer(required) Example: 10Reorder points
Model Stock Level ¶
A model stock level.
Headers
Content-Type: application/jsonBody
{
"id": 123,
"inventory_type_id": 16,
"model_stock_id": 5,
"quantity": 2,
"reorder_point": 1
}Retrieve a Model Stock LevelGET/v1/modelStockLevel/{model_stock_level_id}
Returns a specific model stock level.
- model_stock_level_id
integer(required) Example: 123The id of the model stock level.
Headers
Content-Type: application/jsonBody
{
"inventory_type_id": 16,
"model_stock_id": 5,
"quantity": 2,
"reorder_point": 1
}Update Model Stock LevelPUT/v1/modelStockLevel/{model_stock_level_id}
Update a model stock level.
- model_stock_level_id
integer(required) Example: 123The id of the model stock level.
Delete a Model Stock LevelDELETE/v1/modelStockLevel/{model_stock_level_id}
Delete a specific model stock level.
- model_stock_level_id
integer(required) Example: 123The id of the model stock level.
Model Stock Location ¶
Model Stock Locations ¶
A collection of model stock location.
Headers
Content-Type: application/jsonBody
[
{
"id": 1200,
"location_hierarchy_id": 8,
"model_stock_id": 1200
},
...
]Retrieve all Model Stock LocationsGET/v1/modelStockLocation
Retrieves all model stock locations.
Headers
Content-Type: application/jsonBody
{
"location_hierarchy_id": 8,
"model_stock_id": 1200
}Headers
Content-Type: application/jsonBody
{
"id": "123"
}Create Model Stock LocationPOST/v1/modelStockLocation
Creates a model stock location.
- location_hierarchy_id
integer(required) Example: 123Location hierarchy ID
- model_stock_id
integer(required) Example: 123Model stock ID
Model Stock Location ¶
A model stock location.
Headers
Content-Type: application/jsonBody
{
"id": 1200,
"location_hierarchy_id": 8,
"model_stock_id": 1200
}Retrieve a Model Stock LocationGET/v1/modelStockLocation/{model_stock_location_id}
Returns a specific model stock location.
- model_stock_location_id
integer(required) Example: 123The id of the model stock location.
Headers
Content-Type: application/jsonBody
{
"location_hierarchy_id": 8,
"model_stock_id": 1200
}Update Model Stock LocationPUT/v1/modelStockLocation/{model_stock_location_id}
Update a model stock location.
- model_stock_location_id
integer(required) Example: 123The id of the model stock location.
Delete a Model Stock LocationDELETE/v1/modelStockLocation/{model_stock_location_id}
Delete a specific model stock location.
- model_stock_location_id
integer(required) Example: 123The id of the model stock location.
NeededItem ¶
NeededItem ¶
An Needed item.
Body
{
"order_num": 132231,
"config_id": 213231,
"inventory_id": 132123123,
"warehouse_id": 15,
"stamp": '2012-11-17 10:03:37',
"custom_processed": 1,
}Body
{
"id": "123",
}Create an Needed ItemPOST/v1/neededItem/
Create a new Needed Item.
Headers
Content-Type: application/jsonBody
{
"order_num": 132231,
"config_id": 213231,
"inventory_id": 132123123,
"warehouse_id": 15,
"stamp": '2012-11-17 10:03:37',
"custom_processed": 1,
}Retrieve an Needed ItemGET/v1/neededItem/{needed_item_id}
Retrieve a specific needed Item.
- needed_item_id
integer(required) Example: 123The id of the needed item.
Update an Needed ItemPUT/v1/neededItem/{needed_item_id}
Update a specific needed item.
- needed_item_id
integer(required) Example: 123The id of the needed item.
Delete an Needed ItemDELETE/v1/neededItem/{needed_item_id}
Delete a specific needed item.
- needed_item_id
integer(required) Example: 123The id of the needed item.
Body
[
{
"order_num": 132231,
"config_id": 213231,
"inventory_id": 132123123,
"warehouse_id": 15,
"stamp": '2012-11-17 10:03:37',
"custom_processed": 1,
},
{
"order_num": 132231,
"config_id": 213231,
"inventory_id": 132123123,
"warehouse_id": 15,
"stamp": '2012-11-17 10:03:37',
"custom_processed": 1,
},
{
"order_num": 132231,
"config_id": 213231,
"inventory_id": 132123123,
"warehouse_id": 15,
"stamp": '2012-11-17 10:03:37',
"custom_processed": 1,
},
...
]Retrieve all Needed ItemsGET/v1/neededItem/
Retrieve all needed items.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
id
OrderAdjustment ¶
OrderAdjustment ¶
An order adjustment.
Body
{
"order_num": 966929,
"amount": 2.31,
"type": 2
}Body
{
"id": "12345"
}Create an OrderAdjustmentPOST/v1/orderAdjustment/
Create a new order adjustment.
Top Level Parameters
-
order_numis required. This indicates the order that the adjustment will be attributed to. Orders may be enumerated via theGET /v1/orderendpoint. -
typeis required. This indicates the adjustment type that the adjustment will be attributed to. Price Adjustment Type may be enumerated via theGET /v1/priceAdjustmentTypeendpoint. -
amountis required. This indicates the amount, in dollars, of the adjustment. -
useris optional.
Headers
Content-Type: application/jsonBody
{
"amount": -200,
"description": "Credit"
"id": 123,
"loyalty_points": 0,
"order_num": 38293,
"reward_id": 0,
"stamp": "2019-05-17T16:17:29-04:00",
"type": 1
"user": "coresense"
}Retrieve an order adjustmentGET/v1/orderAdjustment/{order_adjustment_id}
Returns a specific order adjustment.
- order_adjustment_id
integer(required) Example: 123The id of the order adjustment.
OrderAdjustment Collection ¶
A collection of order’s adjustment(s).
Body
[
{
...
"description": "Credit"
"id": 123,
"loyalty_points": 0,
...
},
{
...
"description": "Credit"
"id": 124,
"loyalty_points": 0,
...
},
...
]Retrieve all order adjustmentsGET/v1/orderAdjustment
Retrieves all order adjustments.
OrderDeal ¶
OrderDeal ¶
An order deal.
Body
{
"deal_id": 3,
"order_num": 12345,
"discount_amount": 5.99,
"order_shipping_detail_id": 5678,
}Body
{
"id": "123",
}Create an Order DealPOST/v1/orderDeal/
Create a new order deal.
Headers
Content-Type: application/jsonBody
{
"deal_id": 3,
"order_num": 12345,
"discount_amount": 5.99,
"order_shipping_detail_id": 5678,
}Retrieve an Order DealGET/v1/orderDeal/{order_deal_id}
Retrieve a specific order deal.
- order_deal_id
integer(required) Example: 123The id of the order deal.
Update an Order DealPUT/v1/orderDeal/{order_deal_id}
Update a specific order deal.
- order_deal_id
integer(required) Example: 123The id of the order deal.
Delete an Order DealDELETE/v1/orderDeal/{order_deal_id}
Delete a specific order deal.
- order_deal_id
integer(required) Example: 123The id of the order deal.
OrderDeal Collection ¶
A collection of order deals.
Body
[
{
"deal_id": 3,
"order_num": 12345,
"discount_amount": 5.99,
"order_shipping_detail_id": 5678,
},
{
"deal_id": 3,
"order_num": 12345,
"discount_amount": 5.99,
"order_shipping_detail_id": 5678,
},
{
"deal_id": 3,
"order_num": 12345,
"discount_amount": 5.99,
"order_shipping_detail_id": 5678,
},
...
]Retrieve all Order DealsGET/v1/orderDeal{?order}
Retrieve all order deals.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
id
OrderFulfillment ¶
OrderFulfillment ¶
Fulfillment of an order.
Body
{
[
"order_item_id": 525793,
"sku_id": 9932198
]
}Body
{
"purchase_orders": "No purchase orders created.",
"purchase_order_queue": "Nothing sent to Purchase Order Queue.",
"inventory_assigned": [
{
"qty": 1,
"sku": 9932198,
"warehouse": "CORESense",
"status": "Success"
},
...
],
"inventory_backordered": "No inventory placed on back order.",
"club_memberships_purchased": "No club memberships purchased."
}Process Order FulfillmentPOST/v1/orderFulfillment/
Fulfill an order.
Item Level Parameters
Item Level Parameters are optional. The endpoint may be called with just the order number, which will fulfill all order items - if possible - on the order.
For those Item Leval Parameters that are optional, if not passed, they will default the same as if you were fulfilling the order manually and were using the default options given.
If Item Level Parameters are passed:
-
order_item_idis required. Order Items may be enumerated via theGET /v1/orderItemendpoint. -
sku_idis required. Skus may be enumerated via theGET /v1/sku/endpoint. -
quantityis optional. The total amount of skus to fulfill for that order item. If not provided, it will default to fulfilling as much as possible for the order item. -
build_typeis optional. Either ‘INV’ (Stock Inventory), ‘JIT’ (Just-In-Time) or ‘DS’ (Drop-Ship). -
actionis optional. Either ‘send_now’ (Send Now), ‘queue’ (Queue in PO Manager) or ‘batch’ (Send to PO Queue). -
vendor_idis optional. Vendors may be enumerated via theGET /v1/skuVendorendpoint. -
warehouse_idis optional. Warehouses may be enumerated via theGET /v1/warehouseendpoint. -
shipping_method_idis optional. Shipping methods may be enumerated via theGET /v1/shippingMethodendpoint. -
mediumis optional. Either ‘email’ (Email), ‘fax’ (eFax), ‘document’ (Print) or ‘edi850’ (edi850). -
template_idis optional. -
forceis optional. If the order item / sku combination has already been fulfilled, you can pass this parameter to force it to re-fulfill.
Body
[
{
"order_item_id": 525793,
"sku_id": 9932198,
"quantity": 1,
"build_type": "INV",
"vendor_id": 1079,
"template_id": 0,
"medium": "document",
"warehouse_id": 2,
"shipping_method_id": 7,
"action": "send_now"
},
...
]Retrieve Order FulfillmentGET/v1/orderFulfillment/{order_id}
Returns the default fulfillment methods for each order item on the order. If the order item has already been fully fulfilled, it will return ‘Product #X, SKU #Y has already been fulfilled.’.
- order_id
integer(required) Example: 123The id of the order.
OrderItemAdjustment ¶
OrderItemAdjustment ¶
An order item adjustment.
Body
{
"order_item_id": "12345",
"amount": 2.31,
"increase_decrease": 'increase',
"price_adjustment_type_id": 2
}Body
{
"id": "12345"
}Create an OrderItemAdjustmentPOST/v1/orderItemAdjustment/
Create a new order item adjustment.
Top Level Parameters
-
order_item_idis required. This indicates the order item that the adjustment will be attributed to. Order Items may be enumerated via theGET /v1/orderItemendpoint. -
price_adjustment_type_idis required. This indicates the adjustment type that the adjustment will be attributed to. Price Adjustment Type may be enumerated via theGET /v1/priceAdjustmentTypeendpoint. -
amountis required. This indicates the amount, in dollars, of the adjustment. -
increase_decreaseis required. This indicates whether the adjustment is an increase or decrease to the order item. -
channel_idis optional. If not specified, the order’s originating channel will be used. -
user_idis optional.
Headers
Content-Type: application/jsonBody
{
"amount": 2.31,
"channel_id": 4,
"id": 123,
"increase_decrease": "increase",
"order_item_id": 525793,
"price_adjustment_type_id": 2,
"stamp": "2019-05-17T16:17:29-04:00",
"user_id": 39
}Retrieve an order item adjustmentGET/v1/orderItemAdjustment/{order_item_adjustment_id}
Returns a specific order item adjustment.
- order_item_adjustment_id
integer(required) Example: 123The id of the order item adjustment.
OrderItemAdjustment Collection ¶
A collection of order item’s adjustment.
Body
[
{
...
"channel_id": 4,
"id": 123,
"increase_decrease": "increase",
...
},
{
...
"channel_id": 4,
"id": 124,
"increase_decrease": "decrease",
...
},
...
]Retrieve all order item adjustmentsGET/v1/orderItemAdjustment
Retrieves all order item adjustments.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
idorder_item_id
OrderItemDeal ¶
OrderItemDeal ¶
An order item deal.
Body
{
"deal_id": 3,
"order_item_id": 12345,
"discount_amount": 5.99,
"type": 'deal',
}Body
{
"id": "123",
}Create an Order Item DealPOST/v1/orderItemDeal/
Create a new order item deal.
Headers
Content-Type: application/jsonBody
{
"deal_id": 3,
"order_item_id": 12345,
"discount_amount": 5.99,
"type": 'deal',
}Retrieve an Order Item DealGET/v1/orderItemDeal/{order_item_deal_id}
Retrieve a specific order item deal.
- order_item_deal_id
integer(required) Example: 123The id of the order item deal.
Update an Order Item DealPUT/v1/orderItemDeal/{order_item_deal_id}
Update a specific order item deal.
- order_item_deal_id
integer(required) Example: 123The id of the order item deal.
Delete an Order Item DealDELETE/v1/orderItemDeal/{order_item_deal_id}
Delete a specific order item deal.
- order_item_deal_id
integer(required) Example: 123The id of the order item deal.
OrderItemDeal Collection ¶
A collection of order item deals.
Body
[
{
"deal_id": 3,
"order_item_id": 12345,
"discount_amount": 5.99,
"type": 'deal',
},
{
"deal_id": 3,
"order_item_id": 12345,
"discount_amount": 5.99,
"type": 'deal',
},
{
"deal_id": 3,
"order_item_id": 12345,
"discount_amount": 5.99,
"type": 'deal',
},
...
]Retrieve all Order Item DealsGET/v1/orderItemDeal{?order}
Retrieve all order item deals.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
id
OrderItem ¶
OrderItem ¶
An order item.
Headers
Content-Type: application/jsonBody
{
"amazon_order_item_id": "",
"base_price": 19.95,
"channel_id": 1,
"closed": "",
"cogs": 15.5,
"delivery_date": "2019-05-21T09:39:55-04:00",
"delivery_timing": "immediate pickup",
"id": 123,
"iha_product_overridden": "",
"model_id": 1234,
"order_num": 32432,
"quantity": 2,
"return_price": 19.95,
"returned": "",
"sales_tax": 6,
"sales_tax_total": 2.394,
"salesman": 55,
"stamp": "2009-12-11T08:27:57-05:00",
"total": 39.9
}Retrieve an order itemGET/v1/orderItem/{order_item_id}
Returns a specific order item.
- order_item_id
integer(required) Example: 123The id of the order item.
Delete an Order ItemDELETE/v1/orderItem/{order_item_id}
Delete a specific Order Item.
- order_item_id
integer(required) Example: 123The id of the Order Item.
OrderItem Collection ¶
A collection of order items.
Body
[
{
...
"delivery_timing": "immediate pickup",
"id": 123,
"iha_product_overridden": "",
...
},
{
...
"delivery_timing": "immediate pickup",
"id": 124,
"iha_product_overridden": "",
...
},
...
]Retrieve all order itemsGET/v1/orderItem{?order}
Retrieves all order items.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
order_numidmodel_iddelivery_timingclosed
OrderItemSalesTaxModifierType ¶
OrderItemSalesTaxModifierType ¶
An order item sales tax modifier type.
Headers
Content-Type: application/jsonBody
{
"amount": 10.2,
"id": 123,
"modifier_label": "Sales Tax #24",
"order_item_id": 43324,
"type": "real"
}Retrieve an order item sales tax modifier typeGET/v1/orderItemSalesTaxModifierType/
Returns a specific order item sales tax modifier type.
- order_item_sales_tax_modifier_tye_id
integer(required) Example: 123The id of the order item sales tax modifier type.
OrderItemSalesTaxModifierType Collection ¶
A collection of order item’s sales tax modifier type.
Body
[
{
"amount": 10.20,
"id": 123,
"modifier_label": "Sales Tax #24",
...
},
{
"amount": 2.10,
"id": 124,
"modifier_label": "Temp.",
...
},
...
]Retrieve all order item sales tax modifier typesGET/v1/orderItemSalesTaxModifierType
Retrieves all order item sales tax modifier types.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
id
OrderItemShippingDetail ¶
OrderItemShippingDetail ¶
An order item shipping detail.
Headers
Content-Type: application/jsonBody
{
"id": 123,
"order_shipping_detail_id": 391584,
"order_item_id": 525794,
}Retrieve an order item shipping detailGET/v1/orderItemShippingDetail/
Returns a specific order item shipping detail.
- order_item_shipping_detail
integer(required) Example: 123The id of the order item shipping detail.
OrderItemShippingDetail Collection ¶
A collection of order item’s shipping detail.
Body
[
{
"id": 123,
"order_shipping_detail_id": 391584,
"order_item_id": 525794,
},
{
"id": 124,
"order_shipping_detail_id": 391585,
"order_item_id": 525795,
},
...
]Retrieve all order item shipping detailsGET/v1/orderItemShippingDetail
Retrieves all order item shipping details.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
idorder_shipping_detail_idorder_item_id
Order ¶
Order ¶
An order.
Body
{
"customer_id": "12345",
"channel_id": "1",
"items": [
{
"product_id": "456",
"quantity": "2",
"shipping_method_id": "7",
"productconfigurationoptions": [
{
"id": "123"
},
{
"id": "456"
}
]
},
{
"product_id": "789",
"shipping_method_id": "7",
"warehouse_id": "3",
"productconfigurationoptions": [
{
"id": "789"
},
{
"id": "890"
}
]
}
]
}Body
{
"id": "12345"
}Create an OrderPOST/v1/order/
Create a new order.
Top Level Parameters
-
customer_idis required. If creating an order for a new customer, you must first create a new customer record via thePOST /v1/customerendpoint, which will return the ID. -
channel_idis required. This indicates the sales channel that the order will be attributed to. Channels may be enumerated via theGET /v1/channelendpoint. -
billing_contact_idis optional. If not specified, the customer’s default billing contact will be used. -
shipping_priceis optional. Sets the shipping cost on the order shipping detail. -
payment_receivable_type_idis optional. If provided, a payment with the order balance will be created. -
shipping_tax/shipping_tax_rateare optional. Providing one overrides shipping tax. Otherwise normal shipping tax calculation is done.
Item Level Parameters
Items to be ordered must be specified in an array named items. This parameter must exist and must be an array even if only one item
is being ordered.
-
product_idis required. Products may be enumerated via theGET /v1/productendpoint. -
shipping_method_idis required. Shipping methods may be enumerated via theGET /v1/shippingMethodendpoint. -
quantityis optional and defaults to1if not specified. -
warehouse_idis optional. Warehouses may be enumerated via theGET /v1/warehouseendpoint. If specifed, the item will be sourced from the indicated warehouse. Ifwarehouse_idis provided and no inventory is available there for reservation, the product will be back-ordered. Ifwarehouse_idis not provided, the product will be sourced as specified by your existing sourcing rules. -
shipping_contact_idis optional. If not specified, the customer’s default shipping contact will be used. -
unit_priceis optional. If not specified, the product’s price for the indicated channel will be used. -
amazon_order_item_idis optional. -
sales_tax_rate/sales_taxare optional. Providing one overrides sales tax. Otherwise normal sales tax calculation is done. -
due_dateis optional. Used to set the Payment Due Date on an order. Format is YYYY-MM-DD HH:mm:ss. -
order_statusis optional. This is the order status id. Order statuses may be enumerated via theGET /v1/orderStatusendpoint. -
productconfigurationoptionsis optional. This is an array of IDs of configuration options. Configuration options may be enumerated via theGET /v1/productConfigurationOption/endpoint.
Headers
Content-Type: application/jsonBody
{
"affiliate_id": 0,
"amazon_customer_id": 0,
"amazon_order_id": "12345",
"amt_paid": 32.95,
"billing_contact_id": 298998,
"cancelled": false,
"checked_out": false,
"client_id": 124238,
"closed": true,
"club_cc_reauthorization_sent": false,
"cogs": 7.98715,
"comments": "",
"compliant": false,
"custom_fraudulent": false,
"due_date": "",
"google_financial_status": "REVIEWING",
"google_fulfillment_status": "NEW",
"google_order_num": null,
"grand_total": 32.95,
"ip_address": "",
"key_code": "",
"layaway_expiration_date": null,
"layaway_policy_id": 0,
"layaway_status": null,
"locked": true,
"mail_code": "",
"order_exported": false,
"order_num": 209265,
"order_status": 7,
"originating_brand_id": 1,
"originating_channel_id": 5,
"originating_club_delivery_id": 0,
"originating_club_membership_id": 0,
"paid_stamp": "2017-03-18T10:59:10-04:00",
"payment_invoice_number": null,
"payment_type": 0,
"personalization": false,
"refund_total": 0,
"salesman": "",
"shipping_cost": 0,
"shipping_tax_total": 0,
"stamp": "2017-03-13T22:19:59-04:00",
"total": 24,
"viewed": "foo"
}Retrieve an OrderGET/v1/order/{order_id}
Returns a specific order.
- order_id
integer(required) Example: 123The id of the order.
Order Collection ¶
A collection of orders.
Body
[
{
"affiliate_id": 0,
"amazon_customer_id": 0,
"amazon_order_id": "12345",
...
},
{
"affiliate_id": 0,
"amazon_customer_id": 0,
"amazon_order_id": "12345",
...
},
...
]Retrieve all OrdersGET/v1/order{?order}
Retrieves all orders.
- order
string(optional) Default: id Example: salesmanThe field to sort the result set by. Prefix with
-to invert.Choices:
cancelledclient_idgoogle_order_numgoogle_financial_statusgoogle_fulfillment_statusidlockedorder_statusoriginating_channel_idoriginating_brand_idpayment_invoice_numbersalesmanstamp
Headers
Content-Type: application/jsonBody
{
"locked": 1,
"order_status": 7,
}Headers
Content-Type: application/jsonUpdate an OrderPUT/v1/order
Updates an Order entity.
- order_num
integer(required) Example: 123The id of the order.
Order Shipment Collection ¶
A collection of shipments.
Body
[
{
"arrival_date": "",
"assoc_entity": "order",
"assoc_entity_id": 3,
...
},
{
"arrival_date": "",
"assoc_entity": "order",
"assoc_entity_id": 3,
...
},
...
]Retrieve all Order ShipmentsGET/v1/order/{order_id}/shipment{?order}
Retrieve all shipments for an order.
- order_id
integer(required) Example: 123The id of the order.
- order
string(optional) Default: id Example: statusThe field to sort the result set by. Prefix with
-to invert.Choices:
idstatusexportedassoc_entity
OrderShippingDetail ¶
OrderShippingDetail ¶
An order shipping detail.
Headers
Content-Type: application/jsonBody
{
"delayed_delivery_date": "",
"estimated_delivery_date": "",
"estimated_shipping_date": "2019-05-09",
"id": 123,
"order_num": 966928,
"pickup_warehouse_id": 0,
"saved_shipping_tax_rate": 0,
"shipping_contact_id": 785518,
"shipping_cost": 5.99,
"shipping_method_id": 21
}Retrieve an order shipping detailGET/v1/orderShippingDetail/
Returns a specific order shipping detail.
- order_shipping_detail
integer(required) Example: 123The id of the order shipping detail.
OrderShippingDetail Collection ¶
A collection of order’s shipping detail(s).
Body
[
{
...
"estimated_shipping_date": "",
"id": 123,
"order_num": 966928,
...
},
{
...
"estimated_shipping_date": "",
"id": 124,
"order_num": 966929,
...
},
...
]Retrieve all order shipping detailsGET/v1/orderShippingDetail{?order}
Retrieves all order shipping details.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
idorder_numshipping_contact_id
OrderShippingDetail Update ¶
Update order shipping detail
Headers
Content-Type: application/jsonBody
{
"shipping_method_id": 456,
}Headers
Content-Type: application/jsonUpdate an order shipping detailPUT/v1/orderShippingDetail/{order_shipping_detail_id}
Updates the order shipping detail shipping method only.
- order_shipping_detail_id
integer(required) Example: 123The id of the order shipping detail.
OrderStatus ¶
OrderStatus ¶
An order status.
Headers
Content-Type: application/jsonBody
{
"id": 1,
"status": "Ready to Process"
}Retrieve an Order StatusGET/v1/orderStatus/{order_status_id}
Returns a specific order status.
- order_status_id
integer(required) Example: 123The id of the order_status.
Body
[
{
"id": 1,
"status": "Ready to Process",
},
{
"id": 2,
"status": "Awaiting Payment",
},
...
]Retrieve all Order StatusesGET/v1/orderStatus/
Retrieves all order_statuses.
- order
string(optional) Example: idThe field to sort the result set by. Prefix with
-to invert.
OrderVoid ¶
OrderVoid ¶
Voiding an order.
Body
{
"message": "Order has been voided successfully.",
}Order VoidPUT/v1/orderVoid/{order_id}
Voiding an order
- order_id
integer(required) Example: 123The id of the order.
Payment ¶
Payment ¶
A payment.
Body
{
"assoc_entity": "order",
"assoc_entity_id": 967280,
"payment": 0.01,
"receivable_type_id": 7,
"user": 'coresense',
"client_id": 282219
}Body
{
"id": "12345"
}Create a PaymentPOST/v1/payment/
Create a new payment
Top Level Parameters
-
assoc_entity_idis required. This indicates the order number that the payment will be attributed to. -
assoc_entityis required. This indicates the type (order) that the payment will be attributed to. -
paymentis required. This is the payment’s payment amount. -
receivable_type_idis required. This indicates the type of the payment. Receivable Type may be enumerated via theGET /v1/receivableTypeendpoint. -
client_idis optional. If not specifier, it will use the order’s customer or the return’s customer. -
If a credit card payment, additional parameters are required: **
payment_process_status, which must be ‘authorized’, ‘captured’ or ‘voided’. **payment_processor_id, which must be the payment processor id for the credit card payment. **credit_card_id, which must be the credit card id for the credit card payment.
Headers
Content-Type: application/jsonBody
{
"assoc_entity": "order",
"assoc_entity_id": 966930,
"category": "",
"check_num": 0,
"client_id": 246376
"id": 123,
"memo": "",
"payee": "",
"payment": 13.73,
"payment_gateway_response": "",
"payment_process_auth_code": "",
"payment_process_message": "",
"payment_process_message_type": "message",
"payment_process_status": "n/a",
"payment_process_transaction_id": "",
"payment_processor_id": 0,
"pos_id": 0,
"receivable_type_id": 7,
"stamp": "2019-05-16T14:55:28-04:00",
"user": "coresense",
"void": ""
}Retrieve paymentGET/v1/payment/{payment_id}
Returns a specific payment.
- payment_id
integer(required) Example: 123The id of the payment.
Payment Collection ¶
A collection of order’s payment(s).
Body
[
{
...
"client_id": 246376
"id": 123,
"memo": "",
...
},
{
...
"client_id": 43214
"id": 124,
"memo": "",
...
},
...
]Retrieve all paymentsGET/v1/payment{?order}
Retrieves all payments.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
assoc_entityassoc_entity_ididpos_idreceivable_type_idstampvoid
PriceAdjustmentType ¶
PriceAdjustmentType ¶
A price adjustment type.
Headers
Content-Type: application/jsonBody
{
"bgcolor": "",
"id": 123,
"label": "Discount",
"taxable": 1
}Retrieve a price adjustment typeGET/v1/priceAdjustmentType/{price_adjustment_type_id}
Returns a specific price adjustment type.
- price_adjustment_type_id
integer(required) Example: 123The id of the price adjustment type.
Body
[
{
"bgcolor": "",
"id": 123,
"label": "Discount",
"taxable": 1
},
{
"bgcolor": "",
"id": 124,
"label": "Increase",
"taxable": ""
},
...
]Retrieve all price adjustment typesGET/v1/priceAdjustmentType/
Retrieves all price adjustment types.
Product ¶
Product ¶
A product.
Headers
Content-Type: application/jsonBody
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
"default_needs_own_box": false,
"default_shipping_depth": 0,
"default_shipping_height": 0,
"default_shipping_method_id": 0,
"default_shipping_weight": 0,
"default_shipping_width": 0,
"default_vendor_id": 0,
"description": "This is a nice product.",
"digital_expiration_days": 0,
"digital_maximum_downloads": 0,
"globalshopex_country_of_origin": "US",
"globalshopex_restricted": 0,
"grid_id": 0,
"id": 3,
"image_location": "common/images/products/thumb/03_11697001.jpg",
"last_modified_stamp": "2017-01-09T15:59:47-05:00",
"last_onthefly_id": 1,
"manufacturer_id": 1,
"media_enabled": "0",
"minimum_advertised_price": 0,
"minimum_advertised_price_display": "map_type_1",
"name": "A Nice Thing",
"needs_own_box": false,
"non_inventory": false,
"part_num": "12345",
"personalization_image_uri": "",
"personalization_template_id": 0,
"powerreviews_qa": null,
"powerreviews_rating": 0,
"powerreviews_reviews": "",
"pre_order": false,
"pre_order_available_date": null,
"pre_order_deadline": null,
"pre_order_sale_date": null,
"pricing_group_id": 0,
"product_class": null,
"production_time": 0,
"replaces": 0,
"sku_generation": "manual",
"style_locator": "000-001",
"supports_recurring_orders": true,
"tax_code": null,
"type": 1,
"void": true
}Retrieve a ProductGET/v1/product/{product_id}
Returns a specific product.
- product_id
integer(required) Example: 123The id of the product.
Headers
Content-Type: application/jsonBody
{
"base_price": 35,
"image_location": "common\/images\/products\/thumb\/03_11697001.jpg",
"void": true,
"default_shipping_height": 60
...
}Headers
Content-Type: application/jsonCreate a ProductPOST/v1/product/
Create a product entity.
- base_price
float(required) Example: 123.12Base price of the product
- default_base_cogs
integer(required) Example: 1Default cost over goods
- default_fulfillment
string(required) Example: DROPDefault fullfilment method
- default_needs_own_box
boolean(required) Example: falseWeather need own box for the product?
- default_shipping_depth
float(required) Example: 1.00Default shipping depth of the product
- default_shipping_height
float(required) Example: 1.00Default shipping height of the product
- default_shipping_method_id
integer(required) Example: 123Default shipping method for the product
- default_shipping_weight
float(required) Example: 1.00Default shipping weight of the product
- default_shipping_width
float(required) Example: 1.00Default shipping width of the product
- default_vendor_id
integer(required) Example: 123Default vendor ID
- description
string(required) Example: "This is a nice product."Description of the product
- digital_expiration_days
integer(required) Example: 30Digital Expiration days for the prodcut
- digital_maximum_downloads
integer(required) Example: 10Maximum download limit for the prodcut
- globalshopex_country_of_origin
string(required) Example: "US"Country of origin of the product
- globalshopex_restricted: `1` (integer) - globalshopex_restricted for product
string(required)- grid_id
integer(required) Example: 123Grid ID
- image_location: `"common\/images\/products\/thumb\/03_11697001.jpg"`
string(required)Product image location path
- last_modified_stamp
datetime(required) Example: "2017-01-09T15:59:47-05:00"Last modified date of the product
- last_onthefly_id
integer(required) Example: 1Last on-the-fly ID
- manufacturer_id
integer(required) Example: 1Manufacturer ID
- media_enabled
boolean(required) Example: 1Is media enabled?
- minimum_advertised_price
float(required) Example: 123.12Minimum advertised price of the product
- minimum_advertised_price_display
float(required) Example: 123.12Minimum advertised price to display for the product
- name
string(required) Example: "A Nice Thing"Name of the product
- needs_own_box
boolean(required) Example: falseNeed own box for the product?
- non_inventory
boolean(required) Example: falseNon inventory product
- part_num
string(required) Example: "12345"Product part number
- personalization_image_uri
string(required) Example: "path/from/to/image.ext"Personalization image URI
- personalization_template_id
integer(required) Example: 1Personalization template ID
- powerreviews_rating
float(required) Example: 0.0Power-Review rating
- pre_order
boolean(required) Example: falsePre order the product?
- pricing_group_id
integer(required) Example: 1Pricing group of the product
- replaces
integer(required) Example: 1Replace value for the product
- production_time
integer(required) Example: 123123Production time of the product
- style_locator
string(required) Example: "000-001"Style locator for the product
- supports_recurring_orders
boolean(required) Example: trueDoes the product support recurring orders?
- type
integer(required) Example: 1Type ID for the product
- void
boolean(required) Example: falseIs product void or not?
Headers
Content-Type: application/jsonBody
{
"base_price": 35,
"image_location": "common\/images\/products\/thumb\/03_11697001.jpg",
"void": true,
"default_shipping_height": 60,
"update_sku": true,
...
}Headers
Content-Type: application/jsonUpdate a ProductPUT/v1/product/{product_id}
Updates a product entity.
- product_id
integer(required) Example: 123The id of the product.
- update_sku
boolean(required) Example: falseUpdate all SKU of product on basis of void or not?
Product Collection ¶
A collection of products.
Body
[
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
...
]Retrieve all ProductsGET/v1/product{?order}
Retrieves all products.
- order
string(optional) Default: id Example: part_numThe field to sort the result set by. Prefix with
-to invert.Choices:
idlast_modified_stampmanufacturer_idpart_numtype
Product Category Collection ¶
A collection of categories.
Body
[
{
"active": true,
"category": "root",
"custom_breadcrumb_parent": 0,
...
},
{
"active": true,
"category": "root",
"custom_breadcrumb_parent": 0,
...
},
...
]Retrieve all Product CategoriesGET/v1/product/{product_id}/category{?order}
Retrieve all categories for a product.
- product_id
integer(required) Example: 123The id of the product.
- order
string(optional) Default: id Example: categoryThe field to sort the result set by. Prefix with
-to invert.Choices:
idcategorylabel
Product Category Assignment ¶
Assign a category to a product
Headers
Content-Type: application/jsonBody
{
"position": 2,
"label": "label 123"
}Assign a category to a productPUT/v1/product/{product_id}/category/{category_id}
Assign a category to a product.
- product_id
integer(required) Example: 123The id of the product.
- category_id
integer(required) Example: 123The category ID to assign to the product.
Product Location Collection ¶
A collection of product locations.
Body
[
{
"active": true,
"available_for_fulfillment": true,
"description": "",
...
},
{
"active": true,
"available_for_fulfillment": true,
"description": "",
...
},
...
]Retrieve all Product LocationsGET/v1/product/{product_id}/location{?order,warehouse_id}
Retrieves all product locations.
- product_id
integer(required) Example: 123The id of the product.
- warehouse_id
integer(optional) Example: 123Limit the request to locations in this warehouse.
- order
string(optional) Default: id Example: warehouse_idThe field to sort the result set by. Prefix with
-to invert.Choices:
idparent_idwarehouse_id
Product Channel ¶
Product Channel assignment
Body
{
'active' => true,
'limit_type' => 'unlimited',
'sale_limit' => 10,
'base_price' => 449.99,
'add_to_cart' => true
...
}Assign a channel to productPUT/v1/product/{product_id}/channels/{channel_id}
Assign a channel to a product
- product_id
integer(required) Example: 123The id of the product.
- channel_id
integer(required) Example: 123The channel to assign the product to
Product Channel ¶
Get product channel specific info
Body
{
"active": "n",
"add_to_cart": "yes",
"base_price": "0.00",
"description_text": "SHIRT FULL-ZIP HOODED SWEATSHIRT BLACK - LG",
"image_location": "",
"limit_type": "unlimited",
"model_id": "16414",
"sale_limit": "0",
"stamp": "0000-00-00 00:00:00"
...
}Get product channel specific infoGET/v1/product/{product_id}/channels/{channel_id}
Get product channel specific info
- product_id
integer(required) Example: 123The id of the product.
- channel_id
integer(required) Example: 123The channel to assign the product to
Product Type ¶
Get Product Type Custom Fields
Body
{
'custom_2nd_color' => 123,
'custom_accolades' => 'abc',
'custom_acidity' => 'abc',
'custom_additional_description' => 'abc',
'custom_alcohol_content' => 'abc'
...
}Retrieve Product Type custom fields values to a productGET/v1/product/{product_id}/productType
Product Type Custom Fields
- product_id
integer(required) Example: 123The id of the product.
Product Type ¶
Product Type Custom Fields
Body
{
'custom_2nd_color' => 123,
'custom_accolades' => 'abc',
'custom_acidity' => 'abc',
'custom_additional_description' => 'abc',
'custom_alcohol_content' => 'abc'
...
}Assign Product Type custom fields values to a productPUT/v1/product/{product_id}/productType
Product Type Custom Fields
- product_id
integer(required) Example: 123The id of the product.
ProductConfigurationOption ¶
ProductConfigurationOption ¶
A product configuration option.
Headers
Content-Type: application/jsonBody
{
"active": 1,
"cost": 0,
"id": 123,
"is_default": "",
"label": "Tire SR-R",
"large_image": "",
"legacy_option_id": 42,
"legacy_option_type_id": 2,
"main_image": "",
"position": 1,
"price": 0,
"product_configuration_option_type_id": 5,
"product_id": 532,
"stamp": "2018-03-27T22:09:26-04:00",
"swatch_image": "",
"thumbnail_image": "",
"weight": 0
}Retrieve a product configuration optionGET/v1/productConfigurationOption/{product_configuration_option_id}
Returns a specific product configuration option.
- product_configuration_option_id
integer(required) Example: 123The id of the product configuration option.
ProductConfigurationOption Collection ¶
A collection of product’s configuration option(s).
Body
[
{
...
"cost": 0.00,
"id": 123,
"is_default": "",
...
},
{
...
"cost": 3.00,
"id": 124,
"is_default": 1,
...
},
...
]Retrieve all product configuration optionsGET/v1/productConfigurationOption
Retrieves all product configuration options.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
activeidlegacy_option_idpositionproduct_configuration_option_type_idproduct_id
ProductConfigurationOptionType ¶
ProductConfigurationOptionType ¶
A product configuration option type.
Headers
Content-Type: application/jsonBody
{
"id": 123,
"label": "Size",
"order_data_field": "",
"web_display_text": ""
}Retrieve a product configuration option typeGET/v1/productConfigurationOptionType/{product_configuration_option_type_id}
Returns a specific product configuration option type.
- product_configuration_option_type_id
integer(required) Example: 123The id of the product configuration option type.
Body
[
{
"id": 123,
"label": "Size",
"order_data_field": "",
"web_display_text": ""
},
{
"id": 124,
"label": "Color",
"order_data_field": "",
"web_display_text": ""
},
...
]Retrieve all product configuration option typesGET/v1/productConfigurationOptionType/
Retrieves all product configuration option types.
ProductInventory ¶
ProductInventory ¶
Product inventory.
Headers
Content-Type: application/jsonBody
{
"active": 1,
"id": 123,
"inventory_type_id": 39212,
"model_id": 938291,
"quantity": 1,
"stamp": "2019-05-07T23:04:58-04:00",
"type": "general"
}Retrieve product inventoryGET/v1/productInventory/{product_inventory_id}
Returns a specific product inventory.
- product_inventory_id
integer(required) Example: 123The id of the product inventory.
ProductInventory Collection ¶
A collection of product’s or sku’s product inventory.
Body
[
{
"active": 1,
"id": 123,
"inventory_type_id": 39212,
...
},
{
"active": 1,
"id": 124,
"inventory_type_id": 39212,
...
},
...
]Retrieve all product inventoryGET/v1/productInventory
Retrieves all product inventory.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
idinventory_type_idmodel_id
Body
{
"model_id": 456,
"quantity": 2,
"inventory_type_id": 1234,
"active": true
}Body
{
"id": "12345"
}Create Product InventoryPOST/v1/productInventory
Create a new product inventory.
Parameters
-
model_id:
123(integer) - Product ID -
inventory_type_id:
456(integer) - SKU ID -
quantity:
10(integer) - Quantity of the sku. -
active:
true(boolean) - Is active?
ProductInventoryStandard ¶
ProductInventoryStandard ¶
A product inventory standard.
Headers
Content-Type: application/jsonBody
{
"id": 123,
"option_id": 39212,
"product_inventory_id": 938291,
"active": 1
}Retrieve a product inventory standardGET/v1/productInventoryStandard/{product_inventory_standard_id}
Returns a specific product inventory standard.
- product_inventory_standard_id
integer(required) Example: 123The id of the product inventory standard.
ProductInventoryStandard Collection ¶
A collection of product inventory standard.
Body
[
{
"id": 123,
"option_id": 39212,
"product_inventory_id": 938291,
"active": 1
},
{
"id": 124,
"option_id": 39432,
"product_inventory_id": 923291,
"active": 1
},
...
]Retrieve all product inventory standardsGET/v1/productInventoryStandard
Retrieves all product inventory standards.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
idoption_idproduct_inventory_id
ProductInventoryUpgrade ¶
ProductInventoryUpgrade ¶
A product inventory upgrade.
Headers
Content-Type: application/jsonBody
{
"id": 123,
"option_id": 39212,
"product_inventory_id": 938291,
"active": 1
}Retrieve a product inventory upgradeGET/v1/productInventoryUpgrade/{product_inventory_upgrade_id}
Returns a specific product inventory upgrade.
- product_inventory_upgrade_id
integer(required) Example: 123The id of the product inventory upgrade.
ProductInventoryUpgrade Collection ¶
A collection of product inventory upgrade.
Body
[
{
"id": 123,
"option_id": 39212,
"product_inventory_id": 938291,
"active": 1
},
{
"id": 124,
"option_id": 39432,
"product_inventory_id": 923291,
"active": 1
},
...
]Retrieve all product inventory upgradesGET/v1/productInventoryUpgrade
Retrieves all product inventory upgrades.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
idoption_idproduct_inventory_id
ProductMarkdown ¶
ProductMarkdown [POST]
[/v1/productMarkdown]
Create a new ProductMarkdown.
-
Request
{ "markdown_price" => 86.99, "markdown_type" => 'Promotional', "product_id" => 66002 } -
Response 201
{ "id": "123", }
ProductMarkdown ¶
A product markdown.
Headers
Content-Type: application/jsonBody
{
"deal_id": null,
"id": 3,
"markdown_price": 34.99,
"markdown_type": 'Permanent',
"product_id": 1823,
"stamp": 2014-10-16T12:48:34-04:00
}Retrieve a Product MarkdownGET/v1/productMarkdown/{product_markdown_id}
Returns a specific product markdown.
- product_markdown_id
integer(required) Example: 123The id of the product markdown.
ProductMarkdown Collection ¶
A collection of product markdowns.
Body
[
{
"deal_id": 1,
"id": 381,
"markdown_price": 17.49,
...
},
{
"deal_id": null,
"id": 382,
"markdown_price": 102.32,
...
},
...
]Retrieve all Product MarkdownsGET/v1/productMarkdown{?order}
Retrieves all product markdows.
- order
string(optional) Default: id Example: product_idThe field to sort the result set by. Prefix with
-to invert.Choices:
iddeal_idproduct_id
Update an Product MarkdownPUT/v1/productMarkdown
Update a specific Product Markdown.
- markdown_price
integer(required) Example: 123The price
Delete an Product MarkdownDELETE/v1/productMarkdown
Delete a specific Product Markdown.
- product_markdown_id
integer(required) Example: 123The id of the product Markdown.
ProductPrice ¶
ProductPrice ¶
Product pricing.
Headers
Content-Type: application/jsonBody
{
"base_price": 2.99,
"base_price_after_rebate": 2.79,
"minimum_advertised_price": 1.99,
"rebate_amount": 0.2
}Retrieve a Product PriceGET/v1/productPrice/{product_id}/channel/{channel_id}
Returns pricing for a specific product.
- product_id
integer(required) Example: 123The id of the product.
- channel_id
integer(required) Example: 5The id of the channel.
PurchaseOrder ¶
PurchaseOrder ¶
Purchase Orders.
Headers
Content-Type: application/jsonBody
[
{
"buyer_id": 0,
"cancel_date": null,
"centralized": false,
"cost": 139.9,
"do_not_ship_before_date": "2024-05-15",
"est_receiving_date": "2024-05-15",
"id": "1",
"label": null,
"master_po_number": null,
"medium": "document",
"medium_id": 10,
"notes": null,
"sales_tax": 0,
"shipping_cost": 0,
"shipping_method_id": 1,
"shipping_method_id_2": null,
"stamp": "2008-03-18 09:51:28",
"stamp_closed": "2008-03-18 09:52:05",
"status": "closed",
"terms": null,
"vendor_id": 41,
"warehouse_id": 1
},
...
]Retrieve Purchase OrderGET/v1/purchaseOrder
Retrieve all purchase orders.
PurchaseOrder ¶
Headers
Content-Type: application/jsonBody
{
"buyer_id": 0,
"cancel_date": null,
"centralized": false,
"cost": 139.9,
"do_not_ship_before_date": "2024-05-15",
"est_receiving_date": "2024-05-15",
"id": "1",
"label": null,
"master_po_number": null,
"medium": "document",
"medium_id": 10,
"notes": null,
"sales_tax": 0,
"shipping_cost": 0,
"shipping_method_id": 1,
"shipping_method_id_2": null,
"stamp": "2008-03-18 09:51:28",
"stamp_closed": "2008-03-18 09:52:05",
"status": "closed",
"terms": null,
"vendor_id": 41,
"warehouse_id": 1
}Retrieve Purchase OrderGET/v1/purchaseOrder/{purchase_order_id}
Retrieve a single purchase order.
- purchase_order_id
integer(required) Example: 123The id of the purchase order.
Body
{
...,
"shipping_cost": 235.0,
"shipping_method_id": 1,
"shipping_method_id_2": 3,
"vendor_id": 42,
"warehouse_id": 1,
...
}Update A Purchase OrderPUT/v1/purchaseOrder/{purchase_order_id}
Update a single purchase order.
-
buyer_id:
0(integer) - User ID of buyer, -
centralized:
false(boolean) - Centralized, -
cost:
139.9(float) - Cost of purchase order, -
do_not_ship_before_date:
2024-05-15(datetime) -
est_receiving_date:
2024-05-15(datetime), -
master_po_number:
123(integer) - Master PO number, -
medium:
document(enum) - Document or Email, -
medium_id:
10(integer) - Medium ID (Template ID), -
notes:
lorem ipsum...(string), -
sales_tax:
0(float), -
shipping_cost:
0(float), -
shipping_method_id:
1(integer), -
shipping_method_id_2:
1(integer), -
status:
closed(string) - Status of PO, -
terms:
lorem ipsum..., -
vendor_id:
41(integer), -
warehouse_id:
1(integer)
- purchase_order_id
integer(required) Example: 123The id of the purchase order.
PurchaseOrderSku ¶
PurchaseOrderSku ¶
Headers
Content-Type: application/jsonBody
[
{
"config_id": 0,
"cost": 11.03,
"fulfillment_type": "INV",
"inventory_type_id": 173,
"promise_date": '2024-05-30',
"order_num": 0,
"quantity": 1,
"status": "voided"
},
{
"config_id": 0,
"cost": 11.03,
"fulfillment_type": "INV",
"inventory_type_id": 173,
"promise_date": '2024-05-30',
"order_num": 0,
"quantity": 19,
"status": "unfulfilled"
},
...
]Retrieve Purchase Order SKUsGET/v1/purchaseOrderSku/{purchase_order_id}/purchaseOrderSku
Retrieve all SKU combinations for a single SKU for a purchase order grouped by cost, fulfillment type, order and order item.
- purchase_order_id
integer(required) Example: 123The id of the purchase order.
Body
{
inventory_type_id: 123,
cost: 63.8,
quantity: 12
}Headers
Content-Type: application/jsonCreate Purchase Order SKUPOST/v1/purchaseOrderSku/{purchase_order_id}/purchaseOrderSku
Create a new Purchase Order SKU. If the SKU exists for the purchase order SKU cost combination, it will result in error. In this case, an update using PUT method must be used
-
inventory_type_id:
123(integer) - sku ID (required) -
cost:
236.8(float) - cost mentioned in the po requirements (required) -
quantity:
12(integer) - quantity to add to new PurchaseOrderSKU (required)
- purchase_order_id
integer(required) Example: 123The id of the purchase order.
PurchaseOrderSKU ¶
Body
{
'order_num': 0,
'config_id': 0,
'fulfillment_type': 'INV',
'quantity': 63,
'promise_date': '2024-05-30',
'cost': 2.83
}Headers
Content-Type: application/jsonUpdate a Purchase Order SKUPUT/v1/purchaseOrder/{purchase_order_id}/purchaseOrderSku/{inventory_type_id}
Update a single purchase order SKU. Only quantity can be incremented. Reductions in quantity will have to be done through DELETE operation
-
order_num:
123(integer) - Order ID (if assigned). If not assigned specify as 0 (zero) (required). -
config_id:
123(integer) - Order item ID (if assigned). If not assigned specify as 0 (zero) (required). -
fulfillment_type:
INV(integer) - Fulfillment type (required). -
promise_date:
236.8(date) - promise date (optional). -
cost:
236.8(float) - cost mentioned in the po requirements (required). -
quantity:
12(integer) - quantity to add to new PurchaseOrderSKU (optional).
- purchase_order_id
integer(required) Example: 123The id of the purchase order.
- inventory_type_id
integer(required) Example: 123sku ID.
Body
{
"config_id": 0,
"cost": 11.03,
"fulfillment_type": "INV",
"inventory_type_id": 173,
"promise_date": '2024-05-30',
"order_num": 0,
"quantity": 1,
"status": "voided"
}Retrieve A Purchase Order SKUGET/v1/purchaseOrder/{purchase_order_id}/purchaseOrderSku/{inventory_type_id}
Retrieve SKU combinations for a single SKU for a purchase order grouped by cost, fulfillment type, order and order item.
- purchase_order_id
integer(required) Example: 123The id of the purchase order.
- inventory_type_id
integer(required) Example: 123sku ID.
Body
{
"quantity": 12,
}Body
{
"message": "success"
}Delete A Purchase Order SKUDELETE/v1/purchaseOrder/{purchase_order_id}/purchaseOrderSku/{inventory_type_id}
This creates a receiver to void the PurchaseOrderSku.
- quantity:
12(integer) - quantity to delete (required).
- purchase_order_id
integer(required) Example: 123The id of the purchase order.
- inventory_type_id
integer(required) Example: 123sku ID.
ReceivableType ¶
Receivable Type ¶
A receivable type.
Headers
Content-Type: application/jsonBody
{
"abbrev": "AMEX",
"class": "credit card",
"default_payment_processor_id": 0,
"id": 1,
"label": "American Express",
"payment_type_id": 1
}Retrieve a receivable typeGET/v1/receivableType/{receivable_type_id}
Returns a specific receivable type.
- receivable_type_id
integer(required) Example: 123The id of the receivable type.
Receivable Type Collection ¶
A collection of receivable types.
Body
[
{
"abbrev": "AMEX",
"class": "credit card",
"default_payment_processor_id": 0,
...
},
{
"abbrev": "DISC",
"class": "credit card",
"default_payment_processor_id": 0,
...
},
...
]Retrieve all receivable typesGET/v1/receivableType{?order}
Retrieves all receivable type.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
id
Receiver ¶
Receiver ¶
A receiver.
Body
{
"id": 3,
"master_receiving_document_id": 2,
"stamp": "2010-07-06T14:10:03-04:00",
...
}Body
{
"id": "123",
"uri": "..."
}Create a ReceiverPOST/v1/receiver/
Create a new receiver.
Headers
Content-Type: application/jsonBody
{
"comment": "This receiver was created without ASN",
"exported": false,
"id": 3,
"master_receiving_document_id": 2,
"stamp": "2010-07-06T14:10:03-04:00",
"status": "Received"
}Retrieve a ReceiverGET/v1/receiver/{receiver_id}
Returns a specific receiver.
- receiver_id
integer(required) Example: 123The id of the receiver.
Update a ReceiverPUT/v1/receiver/{receiver_id}
Update a specific receiver.
- receiver_id
integer(required) Example: 123The id of the receiver.
Receiver Collection ¶
A collection of receivers.
Body
[
{
"comment": "This receiver was created without ASN",
"exported": false,
"id": 3,
...
},
{
"comment": "This receiver was created without ASN",
"exported": false,
"id": 3,
...
},
...
]Retrieve all ReceiversGET/v1/receiver{?order}
Retrieves all receivers.
- order
string(optional) Default: id Example: stampThe field to sort the result set by. Prefix with
-to invert.Choices:
idmaster_receiving_document_idstamp
Reorder Points ¶
Reorder Points ¶
Reorder Points.
Body
{
"sku_id": 1,
"location_hierachy_id": 1,
"label": "model stock",
"grid_id": 1,
"model_id": 1,
"default_vendor_id": 1,
"medium": "document",
"medium_id": 1,
"type": "fixed",
"active": true,
"use_distribution_center": true,
"reorder_point": 10,
"quantity": 50
}Headers
Content-Type: application/jsonBody
{
"id": "12345"
}Create Reorder PointPOST/v1/reorder_point/
Creates a reorder point.
Parameters
-
sku_id:
123(integer) - SKU ID -
location_hierarchy_id:
123(integer) - location Hierarchy ID -
label:
model stock(string) - Label -
grid_id:
123(integer) - Grid ID -
model_id:
123(integer) - Model ID -
default_vendor_id:
123(integer) - Default vendor ID -
medium:
Document(enum[“document”,“email”]) - -
medium_id:
123(integer) - integer -
type:
Fixed(enum[“up-to”,“fixed”]) - Type -
active:
true(boolean) - Is active? -
use_distribution_center:
true(boolean) - Does use istribution center? -
reorder_point:
10(integer) - Reorder points -
quantity:
50(integer) - Quantity
Body
{
"sku_id": 1,
"location_hierarchy_id": 1,
"label": "model stock",
"grid_id": 1,
"model_id": 1,
"default_vendor_id": 1,
"medium": "document",
"medium_id": 1,
"type": "fixed",
"active": true,
"use_distribution_center": true,
"reorder_point": 10,
"quantity": 50,
}Headers
Content-Type: application/jsonUpdate Reorder PointPUT/v1/reorder_point/
Update a Reorder Point.
- sku_id
integer(required) Example: 123The id of a SKU
- location_hierarchy_id
integer(required) Example: 123The id of the location_hierarchy
Delete a Reorder PointDELETE/v1/reorder_point/{model_stock_id}
Delete a specific Reorder Point.
- model_stock_id
integer(required) Example: 123The Model Stock ID.
Headers
Content-Type: application/jsonBody
{
"id": "123",
"label": "model stock2",
"grid_id": "1",
"model_id": "1",
"default_vendor_id": "1",
"medium": "",
"medium_id": "1",
"type": "",
"active": "1",
"use_distribution_center": "1",
"model_stock_locations": [
{
"id": "841",
"model_stock_id": "123",
"location_hierarchy_id": "1"
}
],
"model_stock_levels": [
{
"id": "213",
"model_stock_id": "123",
"inventory_type_id": "213",
"reorder_point": "2",
"quantity": "53"
}
]
}Retrieve Reorder Point for specific SKU and locationGET/v1/reorder_point/
Return reorder point information for a specific sku and location.
- sku_id
integer(required) Example: 123The SKU ID.
- location_hierarchy_id
string(required) Example: 123The location_hierarchy ID
Retrieve Reorder Point for specific SKU and all locations ¶
Headers
Content-Type: application/jsonBody
{
"id": "123",
"label": "model stock label",
"grid_id": "1",
"model_id": "1",
"default_vendor_id": "1",
"medium": "",
"medium_id": "1",
"type": "",
"active": "1",
"use_distribution_center": "1",
"model_stock_locations": [
{
"id": "123",
"model_stock_id": "123",
"location_hierarchy_id": "1"
}
],
"model_stock_levels": [
{
"id": "123",
"model_stock_id": "123",
"inventory_type_id": "123",
"reorder_point": "2",
"quantity": "53"
}
]
}Retrieve Reorder Point for specific SKUGET/v1/reordering/{sku_id}/location_hierarchy{?order}
Return reordering information for all locations for a sku.
- order
string(required)- location_hierarchy_id:
123(integer, optional) - The location_hierarchy ID
- location_hierarchy_id:
- sku_id
integer(required) Example: 123The SKU ID.
- location_hierarchy_id
string(required) Example: 123The location_hierarchy ID
Retrieve Reorder Point for specific SKU and all locations ¶
Headers
Content-Type: application/jsonBody
{
"id": "123",
"label": "model stock label",
"grid_id": "1",
"model_id": "1",
"default_vendor_id": "1",
"medium": "",
"medium_id": "1",
"type": "",
"active": "1",
"use_distribution_center": "1",
"model_stock_locations": [
{
"id": "123",
"model_stock_id": "123",
"location_hierarchy_id": "1"
}
],
"model_stock_levels": [
{
"id": "123",
"model_stock_id": "123",
"inventory_type_id": "123",
"reorder_point": "2",
"quantity": "53"
}
]
}Retrieve Reorder Point for specific SKUGET/v1/reordering/{sku_id}/location_hierarchy{?order}
Return reordering information for all locations for a sku.
- order
string(required)- location_hierarchy_id:
123(integer, optional) - The location_hierarchy ID
- location_hierarchy_id:
- sku_id
integer(required) Example: 123The SKU ID.
- location_hierarchy_id
string(required) Example: 123The location_hierarchy ID
Retrieve Reorder Point for specific SKU and all locations ¶
Headers
Content-Type: application/jsonBody
{
"1": {
"id": "1",
"label": null,
"grid_id": "0",
"model_id": "0",
"default_vendor_id": "3057",
"medium": "document",
"medium_id": "44",
"type": "up-to",
"active": "1",
"use_distribution_center": "0",
"model_stock_locations": [
{
"id": "841",
"model_stock_id": "850",
"location_hierarchy_id": "1"
}
],
"model_stock_levels": [
{
"id": "1",
"model_stock_id": "1",
"inventory_type_id": "824",
"reorder_point": "24",
"quantity": "24"
}
]
},
"3": {
"id": "3",
"label": null,
"grid_id": "0",
"model_id": "0",
"default_vendor_id": "297",
"medium": "document",
"medium_id": "41",
"type": "up-to",
"active": "1",
"use_distribution_center": "0",
"model_stock_locations": [
{
"id": "841",
"model_stock_id": "850",
"location_hierarchy_id": "1"
}
],
"model_stock_levels": [
{
"id": "3",
"model_stock_id": "3",
"inventory_type_id": "919",
"reorder_point": "72",
"quantity": "6"
}
]
}
}Retrieve Reorder Point for specific SKUGET/v1/reordering/sku/{location_hierarchy_id}{?order}
Return reordering information for all skus for a given location.
- order
string(required)- sku_id:
123(integer, optional) - The SKU ID
- sku_id:
- sku_id
integer(required) Example: 123The SKU ID.
- location_hierarchy_id
string(required) Example: 123The location_hierarchy ID
Return ¶
Returns ¶
Returns.
Body
{
"order_num": "7702723",
"receivable_type": "standard",
"receivable_type_id": 123,
"return_status": "open",
"receiving_warehouse_id": 19,
"web_rma": "web_rma 1",
"receiving_inventory_location_id": 456789,
"items": [
{
"order_item_id": 25848307,
"quantity": 1,
"reason_code_id": 6,
"inv_to_be_returned": true,
"cust_to_ship": true,
"damage_quantity": 0
},
{
"order_item_id": 25848309,
"quantity": 1,
"reason_code_id": 7,
"inv_to_be_returned": true,
"cust_to_ship": true,
"damage_quantity": 0
}
],
"adjustments": [
{
"type": 7,
"amount": 1,
"description": "Test adjustment"
}
]
}Headers
Content-Type: application/jsonBody
{
"id": "12345"
}Body
{
"order_num": "7702723",
"receivable_type": "cc",
"return_status": "open",
"receiving_warehouse_id": 19,
"web_rma": "web_rma 1",
"receiving_inventory_location_id": 456789,
"items": [
{
"order_item_id": 25848307,
"quantity": 1,
"reason_code_id": 6,
"inv_to_be_returned": true,
"cust_to_ship": true,
"damage_quantity": 0
},
{
"order_item_id": 25848309,
"quantity": 1,
"reason_code_id": 7,
"inv_to_be_returned": true,
"cust_to_ship": true,
"damage_quantity": 0
}
]
}Headers
Content-Type: application/jsonBody
{
"id": "12345"
}Create ReturnPOST/v1/return
Creates a return.
Parameters
-
order_num:
123(integer) - Order number. -
receivable_type:
standard(string) - Receivable type. Allowed values:standard,gc,vc,cc(Gift Certificate, Value Card, or Customer Credit). -
receivable_type_id:
20(integer) - Receivable type ID. -
status:
open(string) - Return status. -
receiving_warehouse_id:
12(integer) - Receiving warehouse ID. -
web_rma:
abcdefg(string) - Web RMA identifier. -
receiving_location_id:
188345(integer) - Receiving location ID. -
items (array)
- order_item_id:
123(integer) - Order item ID. - quantity:
1(integer) - Quantity to be returned. - reason_code_id:
123(integer) - Return reason code ID. - inv_to_be_returned:
true(boolean) - Indicates whether inventory will be returned. - damage_quantity:
1(integer) - Quantity marked as damaged.
- order_item_id:
-
adjustments (array, optional)
- type:
123(integer) - Return adjustment type ID. - amount:
1.00(float) - Return adjustment amount. - description:
Adjustment description(string, optional) - Description of the return adjustment. - original_id:
123(integer, optional) - ID of the existing return adjustment to update. Provide this field only when editing an adjustment. - remove:
true(boolean, optional) - Provide this field only when removing the adjustment from the return.
- type:
Get Return ¶
Get a single return.
Body
{
"status": "success",
"code": 200,
"data": {
"web_rma": "RMA-100001",
"id": "100001",
"stamp": "2025-03-28 14:19:34",
"status": "closed",
"user": "sample_user",
"order_num": "1000001",
"exchange_order_num": null,
"warehouse_id": "Sample Warehouse",
"originating_channel_id": "Sample Channel",
"process_channel_id": "Sample Channel",
"no_of_returned_items": 2,
"subtotal": {
"amount": 214.48,
"currency": "$"
},
"sales_tax_total": {
"amount": 17.16,
"currency": "$"
},
"adjustments": {
"amount": 0,
"currency": "$"
},
"return_promotions_amount_from_order": {
"amount": 0,
"currency": "$"
},
"return_adjustments_amount": {
"amount": 21.45,
"currency": "$"
},
"total": {
"amount": 210.19,
"currency": "$"
},
"shipping_total": {
"amount": 0,
"currency": "$"
},
"shipping_tax_total": {
"amount": 0,
"currency": "$"
},
"refund_payment_method_info": {
"0": {
"amount": {
"amount": 210.19,
"currency": "$"
},
"sublabel": "",
"label": "Credit Card"
},
"total": {
"amount": 210.19,
"currency": "$"
}
},
"closed_date": "2025-03-28",
"expiration_date": null,
"purchasing_customer": {
"first_name": "John",
"last_name": "Doe",
"company": "Sample Company",
"address_line_1": "123 Example Street",
"address_line_2": "Suite 100",
"city": "Sample City",
"state": "CA",
"postal_code": "12345",
"phone": "(555) 555-1234",
"email": "john.doe@example.com"
},
"refunded_customer": {
"first_name": "John",
"last_name": "Doe",
"company": "Sample Company",
"address_line_1": "123 Example Street",
"address_line_2": "Suite 100",
"city": "Sample City",
"state": "CA",
"postal_code": "12345",
"phone": "(555) 555-1234",
"email": "john.doe@example.com"
},
"adjustments_info": [
{
"amount": {
"amount": 21.45,
"currency": "$"
},
"label": "Customer Service Adjustment",
"description": ""
}
],
"adjustment_total": {
"amount": 21.45,
"currency": "$"
},
"return_items": [
{
"unit_refund": {
"amount": 190.99,
"currency": "$"
},
"ext_unit_price": {
"amount": 190.99,
"currency": "$"
},
"expected": {
"damaged": "n",
"return": "y",
"shipping": "y"
},
"id": "200001",
"quantity": "1",
"ordered_item_id": "300001",
"model_id": "400001",
"ordered_item_total": {
"amount": 190.99,
"currency": "$"
},
"return_item_model_id": "400001",
"ordered_item_quantity": "1",
"model_name": "Sample Product A",
"total": {
"amount": 190.99,
"currency": "$"
},
"reason_code": "NEW",
"ordered_item_promos": null
},
{
"unit_refund": {
"amount": 23.49,
"currency": "$"
},
"ext_unit_price": {
"amount": 23.49,
"currency": "$"
},
"expected": {
"damaged": "n",
"return": "y",
"shipping": "y"
},
"id": "200002",
"quantity": "1",
"ordered_item_id": "300002",
"model_id": "400002",
"ordered_item_total": {
"amount": 23.49,
"currency": "$"
},
"return_item_model_id": "400002",
"ordered_item_quantity": "1",
"model_name": "Sample Product B",
"total": {
"amount": 23.49,
"currency": "$"
},
"reason_code": "NEW",
"ordered_item_promos": null
}
],
"total_ext_refund": {
"amount": 214.48,
"currency": "$"
},
"inventory_info": [
{
"id": "200001",
"ordered_item_id": "300001",
"model_id": "400001",
"model_name": "Sample Product A",
"return_item_model_id": "400001",
"status": "assigned",
"quantity": "1",
"cost": {
"amount": 114.29,
"currency": "$"
},
"internal_sku": "SKU-100001",
"label": "LOC-A01",
"expected_damaged": "n",
"expected_return": "y",
"expected_shipping": "y",
"unit_cogs": {
"amount": 114.29,
"currency": "$"
},
"ext_cogs": {
"amount": 114.29,
"currency": "$"
}
},
{
"id": "200002",
"ordered_item_id": "300002",
"model_id": "400002",
"model_name": "Sample Product B",
"return_item_model_id": "400002",
"status": "assigned",
"quantity": "1",
"cost": {
"amount": 15.83,
"currency": "$"
},
"internal_sku": "SKU-100002",
"label": "LOC-A02",
"expected_damaged": "n",
"expected_return": "y",
"expected_shipping": "y",
"unit_cogs": {
"amount": 15.83,
"currency": "$"
},
"ext_cogs": {
"amount": 15.83,
"currency": "$"
}
}
],
"total_ext_cost": {
"amount": 130.12,
"currency": "$"
}
}
}Body
{
"code": 1007,
"message": "Record not found.",
"class": "Coresense\\Rest\\Endpoint\\AbstractEndpoint",
"function": "errorResponse",
"line": 287,
"file": "core-api/src/v1/OrderReturn.php"
}Retreive a ReturnGET/v1/return/{return_id}
Retreive a return
- return_id
integer(required) Example: 123The id of the return.
Headers
x-record-count: 13 (integer) - Total No of records found.
x-page-count: 5 (integer) - Total no of pages.
x-page-size: 3 (integer) - No of records per page.
x-page-number: 1 (integer) - Current page.Body
{
"web_rma": "RMA-100001",
"id": "100001",
"stamp": "2026-03-15 13:21:13",
"status": "void",
"user": "sample_user",
"order_num": "1000001",
"exchange_order_num": null,
"warehouse_id": "Sample Warehouse",
"originating_channel_id": "Sample Channel",
"process_channel_id": "Sample Channel",
"no_of_returned_items": 2,
"subtotal": {
"amount": 217.98,
"currency": "$"
},
"sales_tax_total": {
"amount": 44.32,
"currency": "$"
},
"adjustments": {
"amount": 0,
"currency": "$"
},
"return_promotions_amount_from_order": {
"amount": 0,
"currency": "$"
},
"return_adjustments_amount": {
"amount": 0,
"currency": "$"
},
"total": {
"amount": 218.93,
"currency": "$"
},
"shipping_total": {
"amount": 0,
"currency": "$"
},
"shipping_tax_total": {
"amount": 0,
"currency": "$"
},
"refund_payment_method_info": [],
"closed_date": "2026-04-04",
"expiration_date": null,
"purchasing_customer": {
"first_name": "John",
"last_name": "Doe",
"company": "Sample Company",
"address_line_1": "123 Example Street",
"address_line_2": "Suite 100",
"city": "Sample City",
"state": "CA",
"postal_code": "12345",
"phone": "(555) 555-1234",
"email": "[john.doe@example.com](mailto:john.doe@example.com)"
},
"refunded_customer": {
"first_name": "John",
"last_name": "Doe",
"company": "Sample Company",
"address_line_1": "123 Example Street",
"address_line_2": "Suite 100",
"city": "Sample City",
"state": "CA",
"postal_code": "12345",
"phone": "(555) 555-1234",
"email": "[john.doe@example.com](mailto:john.doe@example.com)"
},
"adjustments_info": null,
"adjustment_total": null,
"return_items": [
{
"unit_refund": {
"amount": 130.99,
"currency": "$"
},
"ext_unit_price": {
"amount": 130.99,
"currency": "$"
},
"expected": {
"damaged": "n",
"return": "y",
"shipping": "y"
},
"id": "200001",
"quantity": "1",
"ordered_item_id": "300001",
"model_id": "400001",
"ordered_item_total": {
"amount": 523.96,
"currency": "$"
},
"return_item_model_id": "400001",
"ordered_item_quantity": "4",
"model_name": "Sample Product A",
"total": {
"amount": 130.99,
"currency": "$"
},
"reason_code": "RTS",
"ordered_item_promos": null
},
{
"unit_refund": {
"amount": 86.99,
"currency": "$"
},
"ext_unit_price": {
"amount": 86.99,
"currency": "$"
},
"expected": {
"damaged": "n",
"return": "y",
"shipping": "y"
},
"id": "200002",
"quantity": "1",
"ordered_item_id": "300002",
"model_id": "400002",
"ordered_item_total": {
"amount": 173.98,
"currency": "$"
},
"return_item_model_id": "400002",
"ordered_item_quantity": "2",
"model_name": "Sample Product B",
"total": {
"amount": 86.99,
"currency": "$"
},
"reason_code": "Damaged",
"ordered_item_promos": null
}
],
"total_ext_refund": {
"amount": 217.98,
"currency": "$"
},
"inventory_info": [
{
"id": "200001",
"ordered_item_id": "300001",
"model_id": "400001",
"model_name": "Sample Product A",
"return_item_model_id": "400001",
"status": "unassigned",
"quantity": "1",
"cost": {
"amount": 49.84,
"currency": "$"
},
"internal_sku": "SKU-100001",
"label": "LOC-A01",
"expected_damaged": "n",
"expected_return": "y",
"expected_shipping": "y",
"unit_cogs": {
"amount": 49.84,
"currency": "$"
},
"ext_cogs": {
"amount": 49.84,
"currency": "$"
}
},
{
"id": "200002",
"ordered_item_id": "300002",
"model_id": "400002",
"model_name": "Sample Product B",
"return_item_model_id": "400002",
"status": "unassigned",
"quantity": "1",
"cost": {
"amount": 38.66,
"currency": "$"
},
"internal_sku": "SKU-100002",
"label": "LOC-A02",
"expected_damaged": "n",
"expected_return": "y",
"expected_shipping": "y",
"unit_cogs": {
"amount": 38.66,
"currency": "$"
},
"ext_cogs": {
"amount": 38.66,
"currency": "$"
}
}
],
"total_ext_cost": {
"amount": 88.5,
"currency": "$"
}
}Headers
x-record-count: 13 (integer) - Total No of records found.
x-page-count: 5 (integer) - Total no of pages.
x-page-size: 3 (integer) - No of records per page.
x-page-number: 1 (integer) - Current page.Body
{
"code": 1007,
"message": "Record not found.",
"class": "Coresense\\Rest\\Endpoint\\AbstractEndpoint",
"function": "errorResponse",
"line": 321,
"file": "core-api/src/v1/OrderReturn.php"
}Retreive a List of ReturnsGET/v1/return/
Get a list of Returns
- web_rma: {web_rma}
database feild(required)Either use web_rma or origination_order_id. Can’t use together.
- origination_order_id
database feild(required) Example: {originating_order_id}Either use web_rma or origination_order_id. Can’t use together.
- page_size
integer(required) Example: 3No of records you want on page.
- page_count
integer(required) Example: 1Page no you want.
Update Return ¶
Update/Process a return.
Body
{
"order_num": "7704934",
"receivable_type_id": 20,
"return_status": "open",
"receiving_warehouse_id": 1,
"web_rma": "RMA-1619494131619",
"receiving_inventory_location_id": "341",
"items": [
{
"order_item_id": 25856514,
"quantity": 1, //set quantity to 0 for removing this item from return
"reason_code_id": 6,
"inv_to_be_returned": true,
"cust_to_ship": true,
"damage_quantity": 0
}
],
"adjustments": [
{
"type": 7,
"amount": 1.0,
"description": "Test adjustment"
}
]
}Body
{
"code": 1011,
"extra": "Return is not in open state.",
"message": "API passthrough failed.",
"class": "Coresense\\Rest\\Endpoint\\AbstractEndpoint",
"function": "errorResponse",
"line": 1490,
"file": "/rest/src/Endpoint/AbstractEndpoint.php"
}Body
{
"code": 1011,
"extra": "Invalid return.",
"message": "API passthrough failed.",
"class": "Coresense\\Rest\\Endpoint\\AbstractEndpoint",
"function": "errorResponse",
"line": 1490,
"file": "/rest/src/Endpoint/AbstractEndpoint.php"
}Body
{
"order_num": "7704934",
"receivable_type_id": 20,
"return_status": "open",
"receiving_warehouse_id": 1,
"web_rma": "RMA-1619494131619",
"receiving_inventory_location_id": "341",
"items": [
{
"order_item_id": 25856514,
"quantity": 1, //set quantity to 0 for removing this item from return
"reason_code_id": 6,
"inv_to_be_returned": true,
"cust_to_ship": true,
"damage_quantity": 0
}
],
"adjustments": [
{
"type": 7,
"amount": 1.0,
"description": "Test adjustment",
"original_id": 45637, // add original_id to edit an adjustment which refers to return_adjustment_id
"remove": true // add this flag to remove this adjustment completely
},
{
"type": 7,
"amount": 1.0,
"description": "Test adjustment"
}
]
}Body
{
"code": 1011,
"extra": "Return is not in open state.",
"message": "API passthrough failed.",
"class": "Coresense\\Rest\\Endpoint\\AbstractEndpoint",
"function": "errorResponse",
"line": 1490,
"file": "/rest/src/Endpoint/AbstractEndpoint.php"
}Body
{
"code": 1011,
"extra": "Invalid return.",
"message": "API passthrough failed.",
"class": "Coresense\\Rest\\Endpoint\\AbstractEndpoint",
"function": "errorResponse",
"line": 1490,
"file": "/rest/src/Endpoint/AbstractEndpoint.php"
}Body
{
"order_num": "7704934",
"receivable_type_id": 20,
"return_status": "process",
"receiving_warehouse_id": 1,
"web_rma": "RMA-1619494131619",
"receiving_inventory_location_id": "341",
"items": [
{
"order_item_id": 25856514,
"quantity": 0, //set quantity to 0 for removing this item from return
"reason_code_id": 10,
"inv_to_be_returned": true,
"cust_to_ship": true,
"damage_quantity": 0
},
{
"order_item_id": 25856515,
"quantity": 1,
"reason_code_id": 10,
"inv_to_be_returned": true,
"cust_to_ship": true,
"damage_quantity": 0
}
]
}Body
{
"code": 1011,
"extra": "Return is not in open state.",
"message": "API passthrough failed.",
"class": "Coresense\\Rest\\Endpoint\\AbstractEndpoint",
"function": "errorResponse",
"line": 1490,
"file": "/rest/src/Endpoint/AbstractEndpoint.php"
}Body
{
"code": 1011,
"extra": "Invalid return.",
"message": "API passthrough failed.",
"class": "Coresense\\Rest\\Endpoint\\AbstractEndpoint",
"function": "errorResponse",
"line": 1490,
"file": "/rest/src/Endpoint/AbstractEndpoint.php"
}Update ReturnPUT/v1/return/{return_id}
Update or Process a return.
- return_id
integer(required) Example: 123The ID of the return.
- order_num
integer(required) Example: 123Order number.
- receivable_type
string(optional) Example: standardReceivable type. Allowed values:
standard,gc,vc,cc(Gift Certificate, Value Card, or Customer Credit).- receivable_type_id
integer(required) Example: 20Receivable type ID.
- status
string(optional) Example: openReturn status. Allowed values:
open,process.- receiving_warehouse_id
integer(required) Example: 12Receiving warehouse ID.
- web_rma
string(optional) Example: abcdefgWeb RMA identifier.
- receiving_location_id
integer(required) Example: 188345Receiving location ID.
- items
array(required)-
order_item_id:
123(integer) - Order item ID. -
quantity:
1(integer) - Quantity to be returned. Set quantity to 0 for removing this item from return -
reason_code_id:
123(integer) - Return reason code ID. -
inv_to_be_returned:
true(boolean) - Indicates whether inventory will be returned. -
damage_quantity:
1(integer) - Quantity marked as damaged.
-
- adjustments
array(optional)-
type:
123(integer) - Return adjustment type ID. -
amount:
1.00(float) - Return adjustment amount. -
description:
Adjustment description(string, optional) - Description of the return adjustment. -
original_id:
123(integer, optional) - ID of the existing return adjustment to update. Provide this field only when editing an adjustment. -
remove:
true(boolean, optional) - Provide this field only when removing the adjustment from the return.
-
Return Void ¶
Voiding a return.
Return VoidDELETE/v1/return/{return_id}
Voiding a return
- return_id
integer(required) Example: 123The id of the return.
Saved Purchase Order ¶
Saved Purchase Orders ¶
Collection of Saved Purchase Orders.
Headers
Content-Type: application/jsonBody
[
...
{
"buyer_id": 15,
"creation_date": "2023-04-27T01:26:04+00:00",
"data": {
"vendor_id": 273,
"buyer_id": 15,
"use_size_runs": false,
"location_type_id": 4,
"receiving_type": "Store",
"transmission_method": "email",
"template": "",
"shipping_method_1": 1,
"shipping_method_2": "",
"terms": "",
"cost_method": "wholesale"
},
"id": 500035,
"label": "My Saved PO",
"last_edited_date": "2023-04-27T01:26:08+00:00",
"replenishment": false,
"sent": true,
"user_id": 15,
"vendor_id": 273
},
...
]
_The response data fields `po_locations`, `po_products`,
`po_quantities`, and `po_size_runs` are excluded for this request
due to their usual large size._Retrieve all Saved Purchase OrdersGET/v1/savedPurchaseOrder
Retrieves all Saved Purchase Orders.
Headers
Content-Type: application/jsonBody
{
"label": "My Saved PO",
"vendor_id": 1,
"buyer_id": 2,
"user_id": 2,
"data": {
"use_size_runs": true,
"location_type_id": 4,
"receiving_type": "Store",
"transmission_method": "email",
"shipping_method_1": 1,
"cost_method": "wholesale",
"template": 53
}
}Headers
Content-Type: application/jsonBody
{
"id": "500044", /* <-- created saved order ID */
"data": {...}
}Create Saved Purchase OrderPOST/v1/savedPurchaseOrder
Creates a Saved Purchase Order.
- label
string(required) Example: My Saved POLabel
- vendor_id
integer(required) Example: 123Vendor ID
- buyer_id
integer(required) Example: 123Buyer ID
- user_id
integer(required) Example: 123User ID
- data
object(required) Example: {}Data
Saved Purchase Order ¶
A Saved Purchase Order.
Headers
Content-Type: application/jsonBody
{
"buyer_id": 15,
"creation_date": "2023-04-27T01:26:04+00:00",
"data": {
"vendor_id": 273,
"buyer_id": 15,
"use_size_runs": false,
"location_type_id": 4,
"receiving_type": "Store",
"transmission_method": "email",
"template": "",
"shipping_method_1": 1,
"shipping_method_2": "",
"terms": "",
"cost_method": "wholesale"
},
"id": 500035,
"label": "My Saved PO",
"last_edited_date": "2023-04-27T01:26:08+00:00",
"replenishment": false,
"sent": true,
"user_id": 15,
"vendor_id": 273,
"po_locations": {...},
"po_products": {...},
"po_quantities": {...}, /* <-- if not size runs used */
"po_size_runs": {...}, /* <-- if size runs used */
},Retrieve Saved Purchase OrderGET/v1/savedPurchaseOrder/{order_id}
Return Saved Purchase Orders detailed information for a specific ID.
- order_id
integer(required) Example: 500044Saved order ID.
Headers
Content-Type: application/jsonBody
{
"label": "My New Saved PO"
}Update Saved Purchase OrderPUT/v1/savedPurchaseOrder/{order_id}
Update a Saved Purchase Order.
- order_id
integer(required) Example: 500044Saved order ID.
Delete a Saved Purchase OrderDELETE/v1/savedPurchaseOrder/{order_id}
Delete a specific Saved Purchase Order.
- order_id
integer(required) Example: 500044Saved order ID.
Saved Purchase Orders Locations ¶
Headers
Content-Type: application/jsonBody
{
"id": "500044",
"po_locations": [
86,
98
]
}Set Saved Purchase Orders locationsPOST/v1/savedPurchaseOrder/{order_id}/locations
Set locations for a Saved Purchase Order.
- order_id
integer(required) Example: 500044Saved order ID.
Saved Purchase Orders Product ¶
Headers
Content-Type: application/jsonBody
{
"product_id": 38845
}Add product to a Saved Purchase OrderPOST/v1/savedPurchaseOrder/{order_id}/product
Add product to a Saved Purchase Order.
- order_id
integer(required) Example: 500044Saved order ID.
Headers
Content-Type: application/jsonBody
{
"product_id": 38845
}Delete product from a Saved Purchase OrderDELETE/v1/savedPurchaseOrder/{order_id}/product
Delete product from a Saved Purchase Order.
- order_id
integer(required) Example: 500044Saved order ID.
Saved Purchase Orders Quantities ¶
Headers
Content-Type: application/jsonBody
/* Non-Grid product quantities */
{
"product_id": 38845,
"po_quantities":
[
{
"sku_id": 2295497,
"quantity": 25
}
]
}
/* Grid product quantities */
{
"product_id": 38845,
"po_quantities":
[
{
"grid_x": 15522,
"grid_y": 2428,
"quantity": 2
},
{
"grid_x": 15524,
"grid_y": 2429,
"quantity": 7
}
]
}
/* Product quantities using size-runs */
{
"product_id": 38845,
"po_quantities":
[
{
"location_hierarchy_id": 86,
"size_run_id": 5566
},
{
"location_hierarchy_id": 98,
"size_run_id": 5567
}
]
}Add quantities to a Saved Purchase OrderPOST/v1/savedPurchaseOrder/{order_id}/quantities
There are three ways to add quantities for a Saved Purchase Order.
- order_id
integer(required) Example: 500044Saved order ID.
Shipment ¶
Shipment ¶
A shipment.
Headers
Content-Type: application/jsonBody
{
"arrival_date": "",
"assoc_entity": "order",
"assoc_entity_id": 3,
"carrier_account_id": 2,
"cod_tracking_num": "",
"cost": 4.8,
"destination": "shipping address",
"destination_id": 0,
"exported": false,
"id": 15,
"method_id": 17,
"needs_recalculation": true,
"picked_up_date": "2017-11-15T15:22:19-05:00",
"ship_date": "2017-02-12T00:00:00-05:00",
"smartpost_tracking_num": "",
"source": "warehouse",
"source_id": 1,
"stamp": "",
"status": "shipped",
"tracking_num": "12345",
"transit_time": 0,
"validated": false
}Retrieve a ShipmentGET/v1/shipment/{shipment_id}
Returns a specific shipment.
- shipment_id
integer(required) Example: 123The id of the shipment.
Update a ShipmentPUT/v1/shipment/{shipment_id}
Update a specific shipment.
- shipment_id
integer(required) Example: 123The id of the shipment.
Delete a ShipmentDELETE/v1/shipment/{shipment_id}
Delete a specific Shipment.
- shipment_id
integer(required) Example: 123The id of the shipment.
Shipment Collection ¶
A collection of shipments.
Body
[
{
"arrival_date": "",
"assoc_entity": "order",
"assoc_entity_id": 3,
...
},
{
"arrival_date": "",
"assoc_entity": "order",
"assoc_entity_id": 3,
...
},
...
]Retrieve all ShipmentsGET/v1/shipment{?order}
Retrieves all shipments.
- order
string(optional) Default: id Example: statusThe field to sort the result set by. Prefix with
-to invert.Choices:
idstatusexportedassoc_entity
Shipment Box Collection ¶
A collection of shipment boxes.
Body
[
{
"depth": 1.0,
"height": 1.0,
"id": 1,
...
},
{
"depth": 1.0,
"height": 1.0,
"id": 2,
...
},
...
]Retrieve all Shipment BoxesGET/v1/shipment/{shipment_id}/box{?order}
Retrieve all boxes for a shipment.
- shipment_id
integer(required) Example: 123The id of the shipment.
- order
string(optional) Default: shipment_id Example: shipment_idThe field to sort the result set by. Prefix with
-to invert.Choices:
shipment_id
ShipmentBox ¶
ShipmentBox ¶
A shipment box.
Headers
Content-Type: application/jsonBody
{
"depth": 0,
"height": 13,
"id": 66,
"shipment_id": 67,
"tracking_num": "892314010010098",
"weight": 0.5,
"width": 8.5
}Retrieve a Shipment BoxGET/v1/shipmentBox/{shipment_box_id}
Returns a specific shipment box.
- shipment_box_id
integer(required) Example: 123The id of the shipment box.
Shipment Box Collection ¶
A collection of shipment boxes.
Body
[
{
"depth": 0,
"height": 13,
"id": 66,
...
},
{
"depth": 0,
"height": 13,
"id": 66,
...
},
...
]Retrieve all Shipment BoxesGET/v1/shipmentBox{?order}
Retrieve all shipment boxes.
- order
string(optional) Default: shipment_id Example: shipment_idThe field to sort the result set by. Prefix with
-to invert.Choices:
shipment_id
Shipment Box Inventory Collection ¶
A collection of shipment box inventory.
Body
[
{
"active": true,
"available_for_fulfillment": true,
"description": "",
...
},
{
"active": true,
"available_for_fulfillment": true,
"description": "",
...
},
...
]Retrieve all Shipment Box InventoryGET/v1/shipmentBox/{shipment_box_id}/inventory{?order}
Retrieves all inventory for a shipment box.
- shipment_box_id
integer(required) Example: 123The id of the shipment_box.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
idinventory_idinventory_location_idstatuswarehouse_id
ShipmentPickerPacker ¶
ShipmentPickerPacker ¶
A shipment picker packer.
Body
{
"pack_stamp": "",
"packer_user_id": 3,
"shipment_id": 23211,
...
},Body
{
"id": "123",
"uri": "..."
}Create a ShipmentPickerPackerPOST/v1/shipmentPickerPacker/
Create a new shipment picker packer.
Headers
Content-Type: application/jsonBody
{
"id": 1,
"pack_stamp": "",
"packer_user_id": 0,
"pick_stamp": 2019-07-18 10:21:59,
"picker_user_id": 2,
"shipment_id": 5432,
}Retrieve a ShipmentPickerPackerGET/v1/shipmentPickerPacker/{shipment_picker_packer_id}
Returns a specific shipment picker packer.
- shipment_picker_packer_id
integer(required) Example: 123The id of the shipment picker packer.
Update a ShipmentPickerPackerPUT/v1/shipmentPickerPacker/{shipment_picker_packer_id}
Update a specific shipment picker packer.
- shipment_picker_packer_id
integer(required) Example: 123The id of the shipment picker packer.
Body
[
{
"id": 1,
"pack_stamp": "",
"packer_user_id": 0,
...
},
{
"id": 2,
"pack_stamp": 2019-07-14 10:21:59,
"packer_user_id": 4,
...
},
...
]Retrieve all ShipmentPickerPackersGET/v1/shipmentPickerPacker/
Retrieves all shipment picker packers.
- order
string(optional) Example: idThe field to sort the result set by. Prefix with
-to invert.
ShippingMethod ¶
ShippingMethod ¶
A shipping method.
Headers
Content-Type: application/jsonBody
{
"active": false,
"carrier_method_id": 24,
"cod": false,
"code": "",
"exclude_product": false,
"force_volume_packing": 0,
"handling_charge": 0,
"handling_charge_type_id": 1,
"id": 25,
"label": "FedEx",
"malvern_method": false,
"pos_method": false,
"production_cutoff_time": "15:00:00",
"production_time": null,
"saturday_delivery": false,
"shipping_cutoff_time": "15:00:00",
"trueship_method": false,
"type": "fedex",
}Retrieve a Shipping MethodGET/v1/shippingMethod/{shipping_method_id}
Returns a specific shipping method.
- shipping_method_id
integer(required) Example: 123The id of the shipping method.
Shipping Method Collection ¶
A collection of shipping methods.
Body
[
{
"active": false,
"carrier_method_id": 24,
"cod": false,
...
},
{
"active": false,
"carrier_method_id": 25,
"cod": false,
...
},
...
]Retrieve all Shipping MethodsGET/v1/shippingMethod{?order}
Retrieve all shipping methods.
- order
string(optional) Default: shipping_method_id Example: shipping_method_idThe field to sort the result set by. Prefix with
-to invert.Choices:
shipping_method_idactive
ShippingReturn ¶
ShippingReturn ¶
A Return that only returns shipping and shipping tax charges.
Body
{
"refunded_client_id": "317442",
"order_num": "7060440",
"shipping_total": 14.99
}Body
{
"id": "12345"
}Create a Shipping ReturnPOST/v1/shippingReturn
Creates a return to only return shipping charges and/or shipping tax.
Parameters
-
refunded_client_id:
12346(integer) - client ID -
order_num:
1256(integer) - Order number -
shipping_total:
0.00(float) - Shipping total to be returned -
shipping_tax_total:
0.00(float) - Shipping tax total to be returned -
status:
open(string, optional) - Replenishment Cost
SKU ¶
SKU ¶
A SKU.
Headers
Content-Type: application/jsonBody
{
"build_type": "INV",
"default_product_id": 1,
"default_shipping_method_id": 1,
"default_vendor_id": 1,
"description": "This is a SKU",
"discontinued": false,
"ean": "",
"freight_class": "500",
"generation": "manual",
"id": 3,
"internal_sku": "12345",
"isbn": "",
"label": "345389",
"manufacturer_id": 1,
"mpn": "",
"needs_own_box": false,
"shipping_delivery_signature_type_id": 1,
"shipping_depth": 0,
"shipping_height": 0,
"shipping_liftgate_delivery_required": false,
"shipping_weight": 0.5,
"shipping_width": 0,
"stamp": "2016-06-27T14:37:35-04:00",
"upc": ""
}Retrieve a SKUGET/v1/sku/{sku_id}
Returns a specific sku.
- sku_id
integer(required) Example: 123The id of the sku.
SKU Collection ¶
A collection of skus.
Body
[
{
"build_type": "INV",
"custom_profits_barcode": "0587440901",
"default_product_id": 9,
"default_shipping_method_id": 34,
"default_vendor_id": 57,
"description": "M Trail Meister Low Taupe",
"discontinued": true,
"ean": "",
"freight_class": "500",
"generation": "manual",
"id": 653,
"internal_sku": "CLBBM\/I3124-25010N",
"isbn": "",
"label": "CLBBM\/I3124-25010N",
"manufacturer_id": 68,
"mpn": "",
"needs_own_box": false,
"product_configuration_selection_id": "653",
"product_id": "9",
"shipping_delivery_signature_type_id": 1,
"shipping_depth": 1,
"shipping_height": 1,
"shipping_liftgate_delivery_required": false,
"shipping_weight": 3,
"shipping_width": 1,
"stamp": "",
"upc": ""
},
{
"build_type": "INV",
"default_product_id": 1,
"default_shipping_method_id": 1,
...
},
...
]Retrieve all SKUsGET/v1/sku{?order}
Retrieves all skus.
- order
string(optional) Default: id Example: upcThe field to sort the result set by. Prefix with
-to invert.Choices:
build_typedefault_vendor_ididmanufacturer_idupc- product_id: 9 (int, optional) - This field to get result of specific product_id
string(required)- merchandise_hierarchy_id
int(optional) Example: 231This field to get all sku related to that merchanise hierarchy
- location_id
int(optional)This field to get all sku related to that inventory location id.
- color
string(optional) Example: redThis field is product congiguration option type …
- size
string(optional) Example: LargeThis field is product congiguration option type …
- subsize
string(optional) Example: NThis field is product congiguration option type …
- pocket_type
string(optional) Example: 10This field is also product congiguration option type …
- custom_material : 3 (int ,optional) This field is product type custom field ... you can send any product type custom field. If it is passed result will include all sku that have custom_material set to value 3.
string(required)
SKU Inventory Collection ¶
A collection of inventory.
Body
[
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
{
"base_price": 35,
"default_base_cogs": 0,
"default_fulfillment": "DROP",
...
},
...
]Retrieve all SKU InventoryGET/v1/sku/{sku_id}/inventory{?order}
Retrieve all inventory for a SKU.
- sku_id
integer(required) Example: 123The id of the SKU.
- order
string(optional) Default: warehouse_id Example: warehouse_idThe field to sort the result set by. Prefix with
-to invert.Choices:
warehouse_id
Headers
Content-Type: application/jsonBody
{
"build_type": "INV",
"default_product_id": 1,
"default_shipping_method_id": 1,
"default_vendor_id": 1,
"description": "SKU desctiption string"
...
}Headers
Content-Type: application/jsonBody
+ product_id: `123` (integer) - Product IDCreate a SKUPOST/v1/sku/inventory
Create a SKU.
- build_type
string(required) Example: "INV"SKU build type
- default_product_id
integer(required) Example: 1Associated default product ID of the SKU
- default_shipping_method_id
integer(required) Example: 1Default shipping method ID of the SKU
- default_vendor_id
integer(required) Example: 1Default vendor method ID of the SKU
- description
string(required) Example: "This is a SKU updated"Text description of the SKU
- discontinued
boolean(required) Example: falseIs the SKU discontinued?
- ean
string(required) Example: "lorem ipsum"- freight_class
string(required) Example: 501Freight class for the SKU
- generation
string(required) Example: "manual"- internal_sku
integer(required) Example: 12345Internal SKU of the SKU
- isbn
string(required) Example: "123456789-1"ISBN info for the SKU
- label
string(required) Example: 123456-lLabel of the SKU,
- manufacturer_id
integer(required) Example: 1Manufacturer ID of the SKU
- mpn
string(required) Example: ""MPN
- needs_own_box
boolean(required) Example: falseSKU need own box to ship?
- shipping_delivery_signature_type_id
integer(required) Example: 1Shipping deliver signature type ID for the SKU
- shipping_depth
float(required) Example: 0.00SKU depth for shipping
- shipping_height
float(required) Example: 0.00SKU height for shipping
- shipping_liftgate_delivery_required
string(required) Example: false(boolean) - is shipping liftgate delivery required for the shipping
- shipping_weight
float(required) Example: 0.00SKU shipping weight
- shipping_width
float(required) Example: 0.00SKU width for shipping
- upc
string(required) Example: ""UPC
Headers
Content-Type: application/jsonBody
{
"build_type": "INV",
"default_product_id": 1,
"default_shipping_method_id": 1,
"default_vendor_id": 1,
"description": "SKU desctiption string"
...
}Headers
Content-Type: application/jsonUpdate a SKUPUT/v1/sku/{sku_id}/inventory
Update a specific SKU.
- sku_id
integer(required) Example: 123The ID of the sku.
SKU Inventory ¶
SKU Inventory ¶
SKU inventory.
Headers
Content-Type: application/jsonBody
{
"location_id": 0,
"quantity": 0,
"sku_id": 1,
"status": "unassigned",
"warehouse_id": 5
}Retrieve SKU InventoryGET/v1/skuInventory/{sku_id}
Returns inventory for a specific sku.
- sku_id
integer(required) Example: 123The id of the sku.
SKU Inventory Collection ¶
A collection of SKU Inventory.
Body
[
{
"location_id": 0,
"quantity": 0,
"sku_id": 1,
...
},
{
"location_id": 0,
"quantity": 0,
"sku_id": 1,
...
},
...
]Retrieve all SKU InventoryGET/v1/skuInventory{?order,movement_date}
Retrieves all SKU inventory.
- movement_date
date(optional) Example: 2018-01-01Only include inventory that has moved since this date.
- order
string(optional) Default: sku_id Example: sku_idThe field to sort the result set by. Prefix with
-to invert.Choices:
sku_id
SKU Vendor ¶
SKU Vendor ¶
SKU vendor.
Headers
Content-Type: application/jsonBody
{
"default_cost": 12.34,
"discount_percent": 0,
"drop_ship_cost": 0,
"id": 123,
"replenishment_cost": 0,
"sku_id": 456,
"stamp": "",
"status": "active",
"stock_qty": 0,
"stock_type": "unlimited",
"vendor_id": 37,
"vendor_sku": "AJZ4702"
}Retrieve SKU VendorGET/v1/skuVendor/{sku_id}
Returns a specific SKU vendor record.
- sku_id
integer(required) Example: 123The id of the SKU.
SKU Vendor Collection ¶
A collection of SKU Vendor records.
Body
[
{
"default_cost": 12.34,
"discount_percent": 0,
"drop_ship_cost": 0,
...
},
{
"default_cost": 12.34,
"discount_percent": 0,
"drop_ship_cost": 0,
...
},
...
]Retrieve all SKU Vendor recordsGET/v1/skuVendor{?order}
Retrieves all SKU vendor records.
- order
string(optional) Default: id Example: sku_idThe field to sort the result set by. Prefix with
-to invert.Choices:
idsku_idstatusvendor_idvendor_sku
Body
{
"default_cost": 12.34,
"discount_percent": 0,
"drop_ship_cost": 0,
"id": 123,
"replenishment_cost": 0,
"sku_id": 456,
"stamp": "",
"status": "active",
"stock_qty": 0,
"stock_type": "unlimited",
"vendor_id": 37,
"vendor_sku": "AJZ4702"
}Body
{
"id": "12345"
}Create SKU VendorPOST/v1/skuVendor
Create a new SKU Vendor.
Parameters
-
default_cost: 12.
00.00(float) - Default Cost -
discount_percent:
0.00(float) - Percentage of the discount -
drop_ship_cost:
0.00(float) - Dropshipping cost -
replenishment_cost:
0.00(float) - Replenishment Cost -
sku_id:
456(integer) - SKU ID -
status: "
active"(string) - State value active/inactive -
stock_qty:
0(integer) - Stock quantity -
stock_type: "
unlimited"(string) - Stock type -
vendor_id:
37(integer) - Vendor ID -
vendor_sku:
"AJZ4702"(string) - Vendor SKU -
stamp:
"0000-00-00 00:00:00"(string) - Vendor SKU
Body
{
"default_cost": 12.34,
"discount_percent": 0,
"drop_ship_cost": 0,
"id": 123,
"replenishment_cost": 0,
"sku_id": 456,
"stamp": "",
"status": "active",
"stock_qty": 0,
"stock_type": "unlimited",
"vendor_id": 37,
"vendor_sku": "AJZ4702"
}Headers
Content-Type: application/jsonUpdate SKU VendorPUT/v1/skuVendor
Update a new SKU Vendor.
- sku_id
integer(required) Example: 123The id of the SKU.
Delete a SKU VendorDELETE/v1/skuVendor
Delete a specific SKU Vendor.
- sku_id
integer(required) Example: 123The SKU ID.
State ¶
State ¶
A state.
Headers
Content-Type: application/jsonBody
{
"id": 1,
"state": "Alabama",
"state_code": "AL"
}Retrieve a StateGET/v1/state/{state_id}
Returns a specific state.
- state_id
integer(required) Example: 123The id of the state.
Contact Collection ¶
A collection of states.
Body
[
{
"id": 1,
"state": "Alabama",
"state_code": "AL"
},
{
"id": 2,
"state": "Alaska",
"state_code": "AK"
},
...
]Retrieve all StatesGET/v1/state{?order}
Retrieves all states.
- order
string(optional) Default: id Example: idThe field to sort the result set by. Prefix with
-to invert.Choices:
idstatestate_code
Transfer ¶
Transfer ¶
A transfer.
Body
{
"close_date": "2011-12-10T19:54:51-05:00",
"destination_sublocation_id": 0,
"destination_warehouse_id": 3,
...
}Body
{
"id": "123",
"uri": "..."
}Create a TransferPOST/v1/transfer/
Create a new transfer.
If the product_id field is not provided in the request, a basic empty transfer will be created.
If the product_id field is provided in the request, the following will occur:
-
A new transfer will be created.
-
Pieces of inventory which meet all the following criteria will be added to the transfer:
- Is an active inventory requirement for the indicated product.
- Is in the source location.
- Is in
unassignedinventory status.
-
The transfer status will be set to
Ready for Pick/Pack.
If product_id is provided and there is no qualifying inventory in the source location, the call will fail and no
transfer will be created.
Headers
Content-Type: application/jsonBody
{
"close_date": "2011-12-10T19:54:51-05:00",
"destination_sublocation_id": 0,
"destination_warehouse_id": 3,
"distribution_purchase_order_id": 0,
"id": 3,
"issue_date": "2011-12-10T19:35:14-05:00",
"medium": "email",
"medium_id": 0,
"notes": "",
"shipping_method_id": 17,
"source_sublocation_id": 0,
"source_warehouse_id": 1,
"status": "Closed",
"transfer_reason_code_id": 0,
"verified": true
}Retrieve a TransferGET/v1/transfer/{transfer_id}
Returns a specific transfer.
- transfer_id
integer(required) Example: 123The id of the transfer.
Update a TransferPUT/v1/transfer/{transfer_id}
Update a specific transfer.
- transfer_id
integer(required) Example: 123The id of the transfer.
Transfer Collection ¶
A collection of transfers.
Body
[
{
"close_date": "2011-12-10T19:54:51-05:00",
"destination_sublocation_id": 0,
"destination_warehouse_id": 3,
...
},
{
"close_date": "2011-12-10T19:54:51-05:00",
"destination_sublocation_id": 0,
"destination_warehouse_id": 3,
...
},
...
]Retrieve all TransfersGET/v1/transfer{?order}
Retrieves all transfers.
- order
string(optional) Default: id Example: statusThe field to sort the result set by. Prefix with
-to invert.Choices:
destination_warehouse_ididstatus
Transfer Receiver Collection ¶
A collection of receivers for a transfer.
Body
{
"id": "123",
"uri": "..."
}Create a Receiver for a TransferPOST/v1/transfer/{transfer_id}/receiver
Creates a receiver for a transfer.
This will create a new receiver and automatically receive all inventory on the transfer.
- transfer_id
integer(required) Example: 123The id of the transfer.
Body
[
{
"comment": "This receiver was created without ASN",
"exported": false,
"id": 3,
...
},
{
"comment": "This receiver was created without ASN",
"exported": false,
"id": 3,
...
},
...
]Retrieve all Receivers for a TransferGET/v1/transfer/{transfer_id}/receiver{?order}
Retrieves all receivers for a transfer.
- transfer_id
integer(required) Example: 123The id of the transfer.
- order
string(optional) Default: id Example: stampThe field to sort the result set by. Prefix with
-to invert.Choices:
idmaster_receiving_document_idstamp
Transfer Inventory Collection ¶
A collection of inventory for a transfer.
Body
[
{
"assoc_entity": "ordered item",
"assoc_entity_id": 1234,
"build_type": "INV",
...
},
{
"assoc_entity": "ordered item",
"assoc_entity_id": 1234,
"build_type": "INV",
...
},
...
]Retrieve all Inventory for a TransferGET/v1/transfer/{transfer_id}/inventory{?order}
Retrieves all inventory for a transfer.
- transfer_id
integer(required) Example: 123The id of the transfer.
- order
string(optional) Default: id Example: warehouse_idThe field to sort the result set by. Prefix with
-to invert.Choices:
idinventory_idinventory_location_idstatuswarehouse_id
User ¶
User ¶
A user account.
Body
[
{
'user': 'coresense',
'first_name': 'test_user_123',
'last_name': 'dummy',
'password': 'Tenpearls001',
'confirm_password': 'Tenpearls001',
'phone_number': '11111111111',
'email_address': 'xyz@123.com',
'default_manager_id': 1,
'management_level': 5,
'location_access_policy_id': 1,
'department': 'admin',
'status': 'Active',
'type': 'Full Time'
},
{
'first_name': 'test_user_123',
'last_name': 'dummy',
'password': 'Tenpearls001',
'confirm_password': 'Tenpearls001',
'phone_number': '11111111111',
'email_address': 'xyz@123.com',
'default_manager_id': 1,
'management_level': 5,
'location_access_policy_id': 1,
'department': 'admin',
'status': 'Active',
'type': 'Full Time'
},
...
]Retrieve all usersGET/v1/user
Returns a list of back office users.
Body
{
'user': 'coresense',
'first_name': 'test_user_123',
'last_name': 'dummy',
'password': 'Tenpearls001',
'confirm_password': 'Tenpearls001',
'phone_number': '11111111111',
'email_address': 'xyz@123.com',
'default_manager_id': 1,
'management_level': 5,
'location_access_policy_id': 1,
'department': 'admin',
'status': 'Active',
'type': 'Full Time'
}Body
{
"user_id": "123",
}Create a UserPOST/v1/user
Create a back office user.
Top Level Parameters
-
useris required. The username of the user. -
first_nameis required. The first name of the user. -
last_nameis required. The last name of the user. -
phone_numberis required. The phone number of the user. -
email_addressis required. The email address of the user. -
passwordis required. The password of the user. -
confirm_passwordis required. -
default_manager_idis required. The default manager id of the user. -
location_access_policy_idis required. The location access policy if of the user. -
departmentis optional. The department of the user. -
statusis required. The status of the user. Choose from ‘Active’,‘Inactive’. -
typeis optional. The type of the user. Choose from ‘Full Time’,‘Part Time’,‘Contractor’,‘Partner’,‘Vendor’
User ¶
Body
{
'user': 'coresense',
'first_name': 'test_user_123',
'last_name': 'dummy',
'password': 'Tenpearls001',
'confirm_password': 'Tenpearls001',
'phone_number': '11111111111',
'email_address': 'xyz@123.com',
'default_manager_id': 1,
'management_level': 5,
'location_access_policy_id': 1,
'department': 'admin',
'status': 'Active',
'type': 'Full Time'
}Retrieve a UserGET/v1/users/{user_id}
Retrieves a single back office user. test phrase.
- user_id
integer(required) Example: 123The id of the user.
Body
{
'first_name': 'test_user_123',
'last_name': 'dummy',
}Update a UserPUT/v1/users/{user_id}
Updates a single back office user.
Top Level Parameters
-
first_nameThe first name of the user. -
last_nameThe last name of the user. -
phone_numberThe phone number of the user. -
email_addressThe email address of the user. -
passwordThe password of the user. -
confirm_password*default_manager_idThe default manager id of the user. -
location_access_policy_idThe location access policy if of the user. -
departmentThe department of the user. -
statusThe status of the user. Choose from ‘Active’,‘Inactive’. -
typeThe type of the user. Choose from ‘Full Time’,‘Part Time’,‘Contractor’,‘Partner’,‘Vendor’
- user_id
integer(required) Example: 123The id of the user.
User Role ¶
Body
[
{
"id": "18",
"label": "Inventory Control / Audit",
"protected": "1"
},
{
"id": "41",
"label": "Warehouse Edits Only",
"protected": "0"
}
]Retrieve all user rolesGET/v1/user/{user_id}/role
Returns a list of roles for a particular back office user.
- user_id
integer(required) Example: 123The id of the user.
Body
[
{
"role_id": "18",
},
{
"role_id": "41",
}
]Assign roles to a userGET/v1/user/{user_id}/role
Assigns mentioned roles to user.
- user_id
integer(required) Example: 123The id of the user.
User Role ¶
Unassign roles from a userDELETE/v1/user/{user_id}/role/{role_id}
Removes assigned role from user
- user_id
integer(required) Example: 123The id of the user.
- role_id
integer(required) Example: 123The id of the role.
UserAccount ¶
UserAccount ¶
A user account.
Body
{
[
"username": 'coresense',
"password": 'Coresense12'
]
}Body
{
"username": "coresense",
"id": 5
}Authenticate a UserPOST/v1/userAccount
Authenticate a back office user.
Top Level Parameters
-
usernameis required. The username of the user. -
passwordis required. The password of the user.
Get Vendor Data ¶
Headers
Content-Type: application/jsonBody
{
"active": "y",
"auto_close_dropship_pos": "n",
"contact_name": "",
"custom_asset_portal": "",
"custom_buyer": "Jay",
"custom_csr_email": "",
"custom_csr_name": "",
"custom_csr_phone": "",
"custom_drop_ship_contact_name": "",
"custom_drop_ship_contact_phone": "",
"custom_drop_ship_fees": "",
"custom_drop_ship_notes": "",
"custom_drop_shop_contact_email": "",
"custom_edi_contact_email": "",
"custom_edi_contact_name": "",
"custom_edi_contact_phone": "",
"custom_edi_id": "",
"custom_edi_qualifier": "",
"custom_main_vendor_contact": "",
"custom_map_contact_email": "",
"custom_map_contact_name": "",
"custom_map_contact_phone": "",
"custom_map_info": "",
"custom_marketing_email": "",
"custom_marketing_name": "",
"custom_marketing_phone": "",
"custom_sales_rep_email": "",
"custom_sales_rep_name": "",
"custom_sales_rep_phone": "",
"custom_small_order_fee": "",
"custom_upc_resource": "",
"custom_vendor_additional_fees": "",
"custom_vendor_code": "511",
"custom_vendor_notes": "",
"default_cost_method": null,
"default_location_hierarchy_type_id": null,
"default_medium": "email",
"default_medium_id": "0",
"default_shipping_method_id_1": null,
"default_shipping_method_id_2": null,
"default_terms": null,
"default_use_size_runs": null,
"dropship_medium_id": "0",
"edi_vendor_id": null,
"fedex_smartpost_hub_id": "0",
"id": "1",
"jit_medium_id": "0",
"main_email": "supershoespos@hhbrown.com",
"main_fax": "209.527.1511",
"main_phone": "866-451-1726",
"name": "511 Tactical",
"partner_id": null,
"requires_liftgate": "1",
"retain_status_dropship_pos": "n",
"send_notification_dropship_pos": "y",
"ship_address1": "4300 Spyres Way",
"ship_address2": "",
"ship_city": "Modesto",
"ship_country": "1",
"ship_state": "12",
"ship_zip": "95356",
"stamp": "0000-00-00 00:00:00"
}Get VendorGET/v1/vendor/{vendor_id}
- vendor_id
integer(required) Example: 1The id of the vendor.
Warehouse ¶
Warehouse ¶
A warehouse.
Headers
Content-Type: application/jsonBody
{
"available_for_fulfillment": false,
"default_damaged_inventory_location_id": 0,
"distribution_center_id": 0,
"fedex_smartpost_hub_id": 0,
"fulfillment_priority": 10,
"id": 3,
"is_distribution_center": false,
"label": "505 Columbus",
"lat": 0,
"location_hierarchy_id": 14,
"lon": 0,
"main_fax": "",
"main_phone": "",
"requires_liftgate": false,
"ship_address1": "",
"ship_address2": "",
"ship_city": "",
"ship_country": 1,
"ship_state": 46,
"ship_zip": "12345",
"timezone": null,
"type": "store"
}Retrieve a WarehouseGET/v1/warehouse/{warehouse_id}
Returns a specific warehouse.
- warehouse_id
integer(required) Example: 123The id of the warehouse.
Warehouse Collection ¶
A collection of warehouses.
Body
[
{
"available_for_fulfillment": false,
"default_damaged_inventory_location_id": 0,
"distribution_center_id": 0,
...
},
{
"available_for_fulfillment": false,
"default_damaged_inventory_location_id": 0,
"distribution_center_id": 0,
...
},
...
]Retrieve all WarehousesGET/v1/warehouse{?order}
Retrieves all warehouses.
- order
string(optional) Default: id Example: labelThe field to sort the result set by. Prefix with
-to invert.Choices:
idlabeltype
Warehouse Location Collection ¶
A collection of warehouse locations.
Body
[
{
"active": true,
"available_for_fulfillment": true,
"description": "",
...
},
{
"active": true,
"available_for_fulfillment": true,
"description": "",
...
},
...
]Retrieve all Locations for a WarehouseGET/v1/warehouse/{warehouse_id}/location{?order}
Retrieves all locations for a warehouse
- warehouse_id
integer(required) Example: 123The id of the warehouse.
- order
string(optional) Default: id Example: warehouse_idThe field to sort the result set by. Prefix with
-to invert.Choices:
idparent_idwarehouse_id
WebData ¶
WebData ¶
A product’s web data.
Headers
Content-Type: application/jsonBody
{
"active": 1,
"availability_calculation": "standard",
"call_for_price": 0,
"display_add_to_cart": 0,
"exclude_from_search": 0,
"main_featured": 'n',
"meta_abstract": "",
"meta_description": "Test Description Here",
"meta_keywords": "",
"meta_title": "",
"out_of_stock_option": "allow_purchase",
"page_title": "",
"product_id": 123,
"reservation_timing": "order_creation",
"reserve_inventory": 1,
"stamp": "2019-09-23T16:25:28-04:00"
}Retrieve Web DataGET/v1/webData/{product_id}
Retrieve a specific product’s web data.
- product_id
integer(required) Example: 123The product id.
Update WebDataPUT/v1/webData/{product_id}
Update a specific product’s web data.
- product_id
integer(required) Example: 123The product id.
WebData Collection ¶
A collection of web data.
Body
[
{
"active": 1,
"availability_calculation": "standard",
"call_for_price": 0,
...
},
{
"active": 0,
"availability_calculation": "extended_availability",
"call_for_price": 1,
...
},
...
]Retrieve all WebDataGET/v1/webData{?order}
Retrieve all web data.
- order
string(optional) Default: produc_id Example: product_idThe field to sort the result set by. Prefix with
-to invert.Choices:
product_idactivemain_featured
Generated by aglio on 05 Jun 2026
Comment ¶
A comment.