Fulfillment App API (0.1)

Download OpenAPI specification:Download

URL: https://apidocs.newstore.io License: NewStore

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.

Get associate

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

Responses

Response samples

200

Content type

application/json

{"associate": {"absent_since": "2019-08-24T14:15:22Z",
"completed_tasks_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": "string",
"image_url": "string",
"is_available": true,
"last_name": "string",
"open_tasks_count": 0,
"revision": 1,
"status": "can_receive_requests",
"store_id": "string",
"telephone_number": "string",
"tenant": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

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

Payload

Content type

application/json

{"status": "can_receive_requests"
}

Response samples

200

Content type

application/json

{"associate": {"absent_since": "2019-08-24T14:15:22Z",
"completed_tasks_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"first_name": "string",
"id": "string",
"image_url": "string",
"is_available": true,
"last_name": "string",
"open_tasks_count": 0,
"revision": 1,
"status": "can_receive_requests",
"store_id": "string",
"telephone_number": "string",
"tenant": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}

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

Payload

Content type

application/json

{"returned_order_items": [{"order_item_uuid": "stringstringstringstringstringstring",
"quality_inspection_code": 0,
"quality_inspection_option": "string",
"return_code": 0,
"return_reason": "string",
"sales_order_item_uuid": "stringstringstringstringstringstring"
}
],
"sales_order_uuid": "stringstringstringstringstringstring",
"store_id": "string"
}

Response samples

200

Content type

application/json

{"return_uuid": "stringstringstringstringstringstring"
}

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

200

Content type

application/json

{ }

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

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

Payload

Content type

application/json

{"message": "string",
"notification_type": "string"
}

Response samples

202

Content type

application/json

{"status": {"message": "string",
"status_identifier": "string"
}
}

Unassigned fufillment requests.

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