Store Fulfillment (0.1)

Download OpenAPI specification:Download

Team Store Fulfillment: team-store-fulfillment@newstore.com URL: https://docs.newstore.net/

Represents the life cycle of on order. From the moment the order is routed to a store until the it's handed over to the customer. This includes processes as: picking, packing, printing required documents.

Store Fulfillment

Represents the life cycle of on order. From the moment the order is routed to a store until the it's handed over to the customer. This includes processes as: picking, packing, printing required documents.

Get fulfillment task by status

Retrieves a list fulfillment tasks in store.

query Parameters

status

string

Enum: "open" "ready_for_pickup" "closed"

The status of the fulfillment tasks.

Responses

Response samples

200
400
500

Content type

application/json

{"fulfillment_tasks": [{"created_on": "2019-08-24T14:15:22Z",
"order_id": "GD0000000001",
"fulfillment_task_id": "e93e698e-c4ac-417a-8a58-47a732c98457",
"fulfillment_request_id": "e93e698e-c4ac-417a-8a58-47a732c98457",
"status": "open",
"picklist": 1
}
]
}

Create new fulfillment task

Create new fulfillment task in store.

header Parameters

Tenant

required

string

Tenant

Request Body schema: application/json

object

fulfillment_node_id required	string Fulfillment node where order should be fulfilled.
order_id required	string Count type related to the import.
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"detail": {"fulfillment_node_id": "string",
"order_id": "string",
"line_items": [{"item_ids": ["string"
],
"product_id": "string"
}
]
}
}

Response samples

200
400
422
500

Content type

application/json

{"created_on": "2019-08-24T14:15:22Z",
"order_id": "GD0000000001",
"fulfillment_task_id": "e93e698e-c4ac-417a-8a58-47a732c98457",
"fulfillment_request_id": "e93e698e-c4ac-417a-8a58-47a732c98457",
"status": "open",
"picklist": 1
}

Get fulfillment tasks overview numbers.

Get fulfillment tasks overview

Retrieves the fulfillment tasks overview information such as number of new, in progress, and ready for pickup orders

Responses

Response samples

200
400
500

Content type

application/json

{"new": 0,
"in_progress": 0,
"ready_for_handover": 0,
"total": 0
}

Get fulfillment task information by id

Get fulfillment task by id

Retrieves a fulfillment task

path Parameters

fulfillment_task_id

required

string <uuid>

Example: 631dfeb6-4743-44b3-87ce-fda62b596760

The identifier of the fulfillment task.

Responses

Response samples

200
400
404
500

Content type

application/json

{"created_on": "2019-08-24T14:15:22Z",
"order_id": "GD0000000001",
"fulfillment_task_id": "e93e698e-c4ac-417a-8a58-47a732c98457",
"fulfillment_request_id": "e93e698e-c4ac-417a-8a58-47a732c98457",
"status": "open",
"picklist": 1
}

Mark order as ready for pickup.

Mark order as ready for pickup

path Parameters

fulfillment_task_id

required

string <uuid>

Example: 631dfeb6-4743-44b3-87ce-fda62b596760

The identifier of the fulfillment task.

header Parameters

Tenant

required

string

Tenant

Responses

Response samples

200
400
422
500

Content type

application/json

{"status": "ready_for_pickup"
}

Marks package as picked up by the carrier.

Marks package as picked up by the carrier

path Parameters

fulfillment_task_id

required

string <uuid>

Example: 631dfeb6-4743-44b3-87ce-fda62b596760

The identifier of the fulfillment task.

header Parameters

Tenant

required

string

Tenant

Responses

Response samples

200
400
422
500

Content type

application/json

{"status": "closed"
}

Get pick lists.

Get pick lists

Retrieves a list of pick lists per store.

header Parameters

Tenant required	string Tenant
user_id required	string User identifier in the platform

Responses

Response samples

200
400
422
500

Content type

application/json

{"picklists": [{"picklist_id": "e93e698e-c4ac-417a-8a58-47a732c98457",
"created_on": "2021-08-18T12:10:06.079694+00:00"
}
]
}

Create pick list.

Generates pick list

Generates pick list. By default, all open orders will be part of the picklist.

header Parameters

Tenant required	string Tenant
user_id required	string User identifier in the platform

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
404
422
500

Content type

application/json

{"picklist_id": "e93e698e-c4ac-417a-8a58-47a732c98457"
}

Get picklist information by id

Get products for the given picklist ID

Retrieves the picklist products

path Parameters

picklist_id

required

string <uuid>

Example: 631dfeb6-4743-44b3-87ce-fda62b596760

The identifier of the picklist.

Responses

Response samples

200
400
404
500

Content type

application/json

{"products": [{"product_id": "e93e698e-c4ac-417a-8a58-47a732c98457",
"quantity": 10,
"color": "blue",
"size": "S",
"title": "Jacket"
}
],
"created_on": "2021-08-18T12:10:06.079694+00:00"
}

Mark item from picklist as picked

path Parameters

picklist_id

required

string <uuid>

Example: 631dfeb6-4743-44b3-87ce-fda62b596760

The identifier of the picklist.

Request Body schema: application/json

object

product_id required	string Product id of the picked item
quantity required	integer Quantity of items picked

Responses

Request samples

Payload

Content type

application/json

{"detail": {"product_id": "string",
"quantity": 0
}
}

Response samples

200
400
404
500

Content type

application/json

{"success": true
}