Skip to main content
API docs by Redocly

Fulfillment App API (0.1)

Download OpenAPI specification:Download

Team Inventory: team-inventory@newstore.com URL: https://apidocs.newstore.io

Implements endpoints used by the app.

Store fulfillment requests

Use this resource to manage orders that are currently in the process of being fulfilled by a store or are in transit from or to a store.

Stores the consumer data.

Stores the consumer data.

path Parameters
correlation_id
required
string

Identifier for the corresponding sales order.

Request Body schema: application/json
email
required
string
first_name
string
last_name
string
phone_number
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "phone_number": "string"
}

Response samples

Content type
application/json
{
  • "successful": true
}

Get associate

Returns the associate object associated with the token sent with the header.

Responses

Response samples

Content type
application/json
{
  • "associate": {
    }
}

Update associate

Updates the associate object.

Request Body schema: application/json
status
required
string
Enum: "can_receive_requests" "cannot_receive_requests" "not_available"

Responses

Request samples

Content type
application/json
{
  • "status": "can_receive_requests"
}

Response samples

Content type
application/json
{
  • "associate": {
    }
}

Reassign orders to new associate

Reassign the list of open fulfillment logistic orders to another associate.

Request Body schema: application/json
current_associate_id
required
string
new_associate_id
required
string

Responses

Request samples

Content type
application/json
{
  • "current_associate_id": "22IB3UROr1S3Je9hDaRh7f",
  • "new_associate_id": "33JB3UROr1S3Je9hDaRh7f"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

List all logistic orders

Gets a list of all fulfillment logistic orders for the current associate.

query Parameters
offset
integer >= 0
Default: 0

The page offset.

count
integer >= 1
Default: 10

The number of requested documents.

q
string

A free text search for orders.

sort
string

The field to sort and its sorting order. These 2 values are separated by the pipe character (|).

filter
string

The field to filter and its filter value(s); field is specified in subscript notation and its values are comma separated. When the value is expression of a range, the min and max range are separated by the "pipe" (|) character.

Responses

List completed logistic orders

Gets a list of all completed fulfillment logistic orders for the current associate.

Responses

List open logistic orders

Gets a list of all the open fulfillment logistic orders for the current associate.

Responses

Get logistic order

Retrieves the specified fulfillment logistic order.

path Parameters
uuid
required
string

The identifier of the fulfillment logistic order.

header Parameters
Retry-After
required
string

The time after the request can be retried.

Responses

Get driver location

Returns the current driver location for same day delivery orders.

path Parameters
uuid
required
string

The identifier of the fulfillment logistic order.

Responses

Initiate return

Initiates the return process for the specified items.

path Parameters
uuid
required
string

The identifier of the fulfillment logistic order.

Request Body schema: application/json
required
Array of objects (returnedItem) non-empty

A list of objects, containing returned items

sales_order_uuid
required
string = 36 characters
store_id
string

The store where the return is initiated from.

Responses

Request samples

Content type
application/json
{
  • "returned_order_items": [
    ],
  • "sales_order_uuid": "stringstringstringstringstringstring",
  • "store_id": "string"
}

Response samples

Content type
application/json
{
  • "return_uuid": "stringstringstringstringstringstring"
}

Execute action

Performs a specific action to fulfill an order.

path Parameters
action
required
string
Enum: "accept" "decline" "mispick" "mispack" "start_packing" "finish_packing" "ready_for_pickup" "confirm_handover"

The specific action to perform for the fulfillment logistic order.

uuid
required
string

The identifier of the fulfillment logistic order.

header Parameters
Retry-After
required
string

The time after the request can be retried.

Request Body schema: application/json
required
Array of objects

A list of boxes for the packing step. Each box can contain multiple items.

items
required
Array of strings[ items = 36 characters ]

A list of fulfillment logistic order item UUIDs. This is necessary for request fulfillment documents.

itn
required
string

The box's itn, needed for easypost, if order>$2500. It is used in skip_packing action

required
Array of objects

A list of objects, containing mispacked item product_id and mispacked_quantity

required
Array of objects

A list of objects, containing mispicked item product_id and mispicked_quantity

package_number
required
integer

Specifies the number of the current package

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "boxes": [
    ],
  • "items": [
    ],
  • "itn": "string",
  • "mispacked_items": [
    ],
  • "mispicked_items": [
    ],
  • "package_number": 0,
  • "scanned_order_items": [
    ]
}

Get product

Returns the product with the given ID.

path Parameters
id
required
string

The identifier of the product.

query Parameters
locale
string

A locale code. Can be used to fetch product information in different languages.

catalog
string

DEPRECATED. Use shop instead. The identifier of the product catalog.

shop
string

The identifier of the shop the product belongs to.

Responses

Response samples

Content type
application/json
{ }

Get return info

Gets the return information of the provided return uuid.

path Parameters
return_uuid
required
string

The identifier of the return.

Responses

Response samples

Content type
application/json
{
  • "currency_code": "str",
  • "refund_note_url": "string",
  • "refunded_amount": 0,
  • "return_fee": 0
}

Get data

Retrieves a dictionary with all the necessary data to set up the NewStore app.

query Parameters
locale
string

A locale code. Can be used to fetch product information in different languages.

Responses

List printer locations.

Returns the list of printer locations set up in the store.

path Parameters
store_id
required
string

The identifier of the store.

Responses

Response samples

Content type
application/json
{
  • "printer_locations": [
    ]
}

Create printer location

Creates a new printer location.

path Parameters
store_id
required
string

The identifier of the store.

Request Body schema: application/json
name
required
string non-empty
store_id
required
string [ 1 .. 256 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "store_id": "string"
}

Response samples

Content type
application/json
{
  • "printer_location": {
    }
}

Get printer location

Returns the printer location with the given ID.

path Parameters
uuid
required
string

The identifier of the printer location.

store_id
required
string

The identifier of the store.

Responses

Response samples

Content type
application/json
{
  • "printer_location": {
    }
}

Update printer location.

Update existing printer location with the given UUID.

path Parameters
uuid
required
string

The identifier of the printer location.

store_id
required
string

The identifier of the store.

Request Body schema: */*
name
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "printer_location": {
    }
}

Delete printer location

Remove the printer location with the given UUID.

path Parameters
uuid
required
string

The identifier of the printer location.

store_id
required
string

The identifier of the store.

Responses

List printers

Returns the list of printers set up in the store.

path Parameters
store_id
required
string

The identifier of the store.

Responses

Response samples

Content type
application/json
{
  • "printers": [
    ]
}

Create printer

Creates a new printer.

path Parameters
store_id
required
string

The identifier of the store.

Request Body schema: application/json
ipv4
string <ipv4> <= 16 characters
ipv6
string <ipv6> <= 40 characters
location
string <= 100 characters
mac_address
string [ 17 .. 32 ] characters
manufacturer
required
string
Enum: "Virtual" "Star" "AirPrint"
model
string [ 3 .. 64 ] characters
name
required
string [ 3 .. 64 ] characters
paper_size
string or null <= 32 characters
printer_location_id
string = 36 characters
store_id
required
string [ 1 .. 256 ] characters
type
required
string
Enum: "document_printer" "label_printer"
url
string <= 256 characters

Responses

Request samples

Content type
application/json
{
  • "ipv4": "192.168.0.1",
  • "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  • "location": "string",
  • "mac_address": "stringstringstrin",
  • "manufacturer": "Virtual",
  • "model": "string",
  • "name": "string",
  • "paper_size": "string",
  • "printer_location_id": "stringstringstringstringstringstring",
  • "store_id": "string",
  • "type": "document_printer",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "printer": {
    }
}

Get printer

Returns the printer with the given ID.

path Parameters
uuid
required
string

The identifier of the printer.

store_id
required
string

The identifier of the store.

Responses

Response samples

Content type
application/json
{
  • "printer": {
    }
}

Update printer

Updates existing printer with the given UUID.

path Parameters
uuid
required
string

The identifier of the printer.

store_id
required
string

The identifier of the store.

Request Body schema: appplication/json
ipv4
string <ipv4> <= 16 characters
ipv6
string <ipv6> <= 40 characters
location
string <= 100 characters
mac_address
string [ 17 .. 32 ] characters
manufacturer
required
string
Enum: "Virtual" "Star" "AirPrint"
model
string [ 3 .. 64 ] characters
name
required
string [ 3 .. 64 ] characters
paper_size
string or null <= 32 characters
printer_location_id
string = 36 characters
store_id
required
string [ 1 .. 256 ] characters
type
required
string
Enum: "document_printer" "label_printer"
url
string <= 256 characters

Responses

Request samples

Content type
appplication/json
{
  • "ipv4": "192.168.0.1",
  • "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  • "location": "string",
  • "mac_address": "stringstringstrin",
  • "manufacturer": "Virtual",
  • "model": "string",
  • "name": "string",
  • "paper_size": "string",
  • "printer_location_id": "stringstringstringstringstringstring",
  • "store_id": "string",
  • "type": "document_printer",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "printer": {
    }
}

Delete printer

Removes the printer with the given UUID.

path Parameters
uuid
required
string

The identifier of the printer.

store_id
required
string

The identifier of the store.

Responses

Sends test notification.

Sends a test notification to the user. Use this method to verify the notification setup.

Request Body schema: application/json
message
string

The message that will be sent in the notification, a default message is used if none is provided.

notification_type
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "notification_type": "string"
}

Response samples

Content type
application/json
{
  • "status": {
    }
}

Unassigned fufillment requests.

Gets the count of unassigned fulfillment requests, based on the priority.

Responses