• Store fulfillment configuration
  • getGet pending timer duration for a tenant
  • postSet pending timer duration configuration for a tenant.
  • getCheck advance delivery booking
  • postBook delivery in advance
  • getGet packing timer duration
  • postSet packing timer duration
  • getGet picking timer for an item
  • postSet picking timer for an item
• Store fulfillment requests
  • postReassign orders to new associate
  • postAccept store fulfillment request
  • postDecline store fulfillment request
  • postMispick store fulfillment request
  • postMispack store fulfillment request
  • postStart packing store fulfillment request
  • postFinish packing store fulfillment request
  • postFinish packing store fulfillment request
  • postFinish packing store fulfillment request
  • postDEPRECATED, OLD FLOW ONLY. Cancel item for the given fulfillment request id
  • patchUpdate shipping status
  • postCancel store fulfillment request
• Store Fulfillment shipment
  • postBook (or retry) shipment for this fulfillment
  • getRetrieves shipment status for this shipment
  • getRetrieves documents for this shipment
• Get store configuration
  • getGet relation between stores and package_options
• Update store configuration
  • postSet relation between stores and package_options
• Get packages configuration
  • getGet package options
• Update packages configuration
  • postSet package options

API docs by Redocly

Associate (Deprecated) (0.1)

Download OpenAPI specification:Download

Team Store Fulfillment: team-store-fulfillment@newstore.com URL: https://docs.newstore.net License: Proprietary. All rights reserved.

API responsible for handling internal operations that manage fulfillment orders routed to a store. Please note that this API is deprecated.

Store fulfillment configuration

Use this resource to configure store timer configuration.

Get pending timer duration for a tenant

Retrieves the pending timer duration for the retailer. This timer is the waiting time to respond to a fulfillment request. See the guide.

Responses

/v0/d/configuration/pending_timer_duration

Response samples

• 200
• 400

Content type

application/json

0

0

Set pending timer duration configuration for a tenant.

Use this method to set a fulfillment timer for the retailer. This timer is the waiting time for an associate to respond to a fulfillment request before it is routed to another associate. See the guide.

Request Body schema: application/json

integer >= 1

Duration seconds

Responses

/v0/d/configuration/pending_timer_duration

Request samples

• Payload

Content type

application/json

1

Response samples

• 200
• 400

Content type

application/json

0

0

Check advance delivery booking

Checks if the delivery for the order should be booked in advance.

Responses

/v0/d/configuration/book_delivery_in_advance

Response samples

• 200
• 400

Content type

application/json

true

Book delivery in advance

Specifies that the delivery should be booked in advance.

Request Body schema: application/json

boolean

True or False

Responses

/v0/d/configuration/book_delivery_in_advance

Request samples

• Payload

Content type

application/json

true

Response samples

• 200
• 400

Content type

application/json

true

Get packing timer duration

Retrives the packing timer duration configured for the retailer. This timer is the waiting time displayed to an associate during the packing stage of fulfillment.

Responses

/v0/d/configuration/packing_timer_duration

Response samples

• 200
• 400

Content type

application/json

0

0

Set packing timer duration

Specifies the packing timer duration configured for the retailer. This timer is the waiting time displayed to an associate during the packing stage of fulfillment.

Request Body schema: application/json

integer >= 1

Duration seconds

Responses

/v0/d/configuration/packing_timer_duration

Request samples

• Payload

Content type

application/json

1

Response samples

• 200
• 400

Content type

application/json

0

0

Get picking timer for an item

Retrieves the duration of the timer configured for the retailer. The timer is displayed to the associate in NewStore Fulfillment App, during the picking stage of order fulfillment for each item.

Responses

/v0/d/configuration/duration_per_item

Response samples

• 200
• 400

Content type

application/json

0

0

Set picking timer for an item

Specifies the duration of the timer configured for the retailer. The timer is displayed to the associate in NewStore Fulfillment App, during the picking stage of order fulfillment for each item.

Request Body schema: application/json

integer >= 1

Duration seconds

Responses

/v0/d/configuration/duration_per_item

Request samples

• Payload

Content type

application/json

1

Response samples

• 200
• 400

Content type

application/json

0

0

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.

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

/v0/d/fulfillment_associate/_reassign

Request samples

• Payload

Content type

application/json

{

• "current_associate_id": "22IB3UROr1S3Je9hDaRh7f",
• "new_associate_id": "33JB3UROr1S3Je9hDaRh7f"

}

Response samples

• 400
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": "associates_in_different_stores",
  • "description": "Chosen associates are not assigned to the same store, choose another associate.",
  • "extended_attributes": { }

  }

}

Accept store fulfillment request

Use this method to accept a fulfillment request.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Request Body schema: application/json

itn	string The box's itn, needed for easypost, if order>$2500

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/accept

Request samples

• Payload

Content type

application/json

{

• "itn": "string"

}

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

Decline store fulfillment request

Use this method to decline a fulfillment request.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/decline

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

Mispick store fulfillment request

Use this method to mispick a fulfillment request.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Request Body schema: application/json

	Array of objects A list of objects, containing mispicked item product_id and mispicked_quantity
Array mispicked_quantity required integer Number of mispicked products. product_id required string The identifier for the product.

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/mispick

Request samples

• Payload

Content type

application/json

{

• "mispicked_items": [

  • {

    • "mispicked_quantity": 0,
    • "product_id": "string"

    }

  ]

}

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

Mispack store fulfillment request

Use this method to mispack a fulfillment request.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Request Body schema: application/json

	Array of objects A list of objects, containing mispacked item product_id and mispacked_quantity
Array mispacked_quantity required integer Number of mispacked products. product_id required string The identifier for the product.

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/mispack

Request samples

• Payload

Content type

application/json

{

• "mispacked_items": [

  • {

    • "mispacked_quantity": 0,
    • "product_id": "string"

    }

  ]

}

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

Start packing store fulfillment request

Use this method to start packing a fulfillment request.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Request Body schema: application/json

	Array of objects
itn	string The box's itn, needed for easypost, if order>$2500

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/start_packing

Request samples

• Payload

Content type

application/json

{

• "scanned_order_items": [

  • {

    • "external_identifier": {

      • "EAN": "string",
      • "EPC": "string",
      • "SKU": "string"

      },
    • "itn": "string",
    • "order_item_uuid": "stringstringstringstringstringstring"

    }

  ],
• "itn": "string"

}

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

Finish packing store fulfillment request

Use this method to finish packing a fulfillment request.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Request Body schema: application/json

	Array of objects A list of boxes for the packing step. Each box can contain multiple items.
itn	string The box's itn, needed for easypost, if order>$2500

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/finish_packing

Request samples

• Payload

Content type

application/json

{

• "boxes": [

  • {

    • "index": 0,
    • "items": [

      • {

        • "external_identifier": {

          • "EAN": "string",
          • "EPC": "string",
          • "SKU": "string"

          },
        • "order_item_uuid": "stringstringstringstringstringstring"

        }

      ],
    • "itn": "string",
    • "package_option_uuid": "stringstringstringstringstringstring"

    }

  ],
• "itn": "string"

}

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

Finish packing store fulfillment request

Use this method to mark a fulfillment request as ready for pickup

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/ready_for_pickup

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

Finish packing store fulfillment request

Use this method to confirm handover on a fulfillment request

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/confirm_handover

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

DEPRECATED, OLD FLOW ONLY. Cancel item for the given fulfillment request id Deprecated

Removes the specified item from the order and rejects the item that are part of the store fulfillment request.

To cancel items that are part of orders fulfilled by a DC, use this API instead.

path Parameters

fulfillment_request_id required	string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.
sales_order_item_uuid required	string The identifier of the order item in NewStore.

Request Body schema: application/json

object

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/cancel_item/{sales_order_item_uuid}

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 400

Content type

application/json

{

• "success": true

}

Update shipping status

Marks some or all items in a fulfillment request assigned to a store as shipped.

When an order cannot be fulfilled in a store because of external reasons such as the failure of a shipment provider API, the retailer usually ships the items manually. However, this data is not processed in NewStore, which leads to order data that is not in sync for the retailer.

Use this endpoint to manually mark such shipments that have been done outside of NewStore as shipped, and keep the order and routing data in sync with the real world.

Important: Using this method overrides system workflow rules and the actual status of the shipment, and marks the specified items as shipped.

To update the shipping status of orders that are fulfilled by a DC, use this method instead.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Request Body schema: application/json

tracking_code required	string <str> The tracking code sent by your shipment provider.
provider required	string The name of your shipping provider. The shipping provider you specify here must be configured for your business. For more information on how to configure shipping providers, see the docs.

Responses

/v0/d/fulfillment_logistic_orders/{fulfillment_request_id}/mark_as_shipped

Request samples

• Payload

Content type

application/json

{

• "tracking_code": "9999999999",
• "provider": "FedEx"

}

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

Cancel store fulfillment request

Use this method to cancel a fulfillment request that has been routed to a store for fulfillment.

This method does not consider the current status of the items that are part of the fulfillment request, or how far they have progressed in the order fulfillment process.

Use this method to cancel items in an order that:

• Are not possible to fulfill because of a fulfillment error.
• The customer decided to cancel after placing their order.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Request Body schema: application/json

object

Responses

/v0/d/fulfillment_logistic_order/{fulfillment_request_id}/_force_cancel

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 400

Content type

application/json

{

• "error_data": {

  • "code": "string",
  • "description": "string"

  }

}

Store Fulfillment shipment

Book (or retry) shipment for this fulfillment

Use this method to book or retry shipment for a fulfillment request that was routed to a store.

This method does not consider the current status of the items that are part of the fulfillment request, or how far they have progressed in the order fulfillment process.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Request Body schema: application/json

object

Responses

/v0/d/fulfillment-requests/{fulfillment_request_id}/shipment

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 201
• 400

Content type

application/json

{

• "status": "accepted"

}

Retrieves shipment status for this shipment

Use this method to book or retry shipment for a fulfillment request that was routed to a store.

This method does not consider the current status of the items that are part of the fulfillment request, or how far they have progressed in the order fulfillment process.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Responses

/v0/d/fulfillment-requests/{fulfillment_request_id}/shipment

Response samples

• 200
• 400

Content type

application/json

{

• "status": "accepted",
• "label_url": "string"

}

Retrieves documents for this shipment

Use this method to retrieve printable documents for a fulfillment request that was routed to a store.

path Parameters

fulfillment_request_id required

string <uuid> Example: 631dfeb6-4743-44b3-87ce-fda62b596760 The identifier of the fulfillment request id.

Responses

/v0/d/fulfillment-requests/{fulfillment_request_id}/documents

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "document": "shipping_label",
  • "status": "pending",
  • "url": "string"

  }

]

Get store configuration

Get relation between stores and package_options

Use this method to get relation between stores and package_options for a tenant.

Responses

/v0/d/configuration/stores

Response samples

• 200
• 400

Content type

application/json

{

• "stores": [

  • {

    • "store_id": "string",
    • "package_options": [

      • "string"

      ],
    • "default_package": "string"

    }

  ]

}

Update store configuration

Set relation between stores and package_options

Use this method to set relation between stores and package_options for a tenant.

Request Body schema: application/json

	Array of objects
Array store_id string ID of the store package_options Array of strings Package option IDs of the store default_package string ID of the default package option

Responses

/v0/d/configuration/stores

Request samples

• Payload

Content type

application/json

{

• "stores": [

  • {

    • "store_id": "string",
    • "package_options": [

      • "string"

      ],
    • "default_package": "string"

    }

  ]

}

Response samples

• 200
• 400

Content type

application/json

{

• "stores": [

  • {

    • "store_id": "string",
    • "package_options": [

      • "string"

      ],
    • "default_package": "string"

    }

  ]

}

Get packages configuration

Get package options

Use this method to get package options for a tenant.

Responses

/v0/d/configuration/packages

Response samples

• 200
• 400

Content type

application/json

{

• "packages": [

  • {

    • "uuid": "07403398-4dbc-4434-80e4-56f176008d4b",
    • "name": "L",
    • "weight": 1.74,
    • "weight_unit": "lb",
    • "length": 42.55,
    • "width": 53.34,
    • "height": 19.91,
    • "length_unit": "cm"

    }

  ]

}

Update packages configuration

Set package options

Use this method to set package options for a tenant.

Request Body schema: application/json

	Array of objects
Array uuid string uuid of the package name string name of the package weight number weight of the package weight_unit string weight_unit of the package length number length of the package width number width of the package height number height of the package length_unit string length_unit of the package

Responses

/v0/d/configuration/packages

Request samples

• Payload

Content type

application/json

{

• "packages": [

  • {

    • "uuid": "07403398-4dbc-4434-80e4-56f176008d4b",
    • "name": "L",
    • "weight": 1.74,
    • "weight_unit": "lb",
    • "length": 42.55,
    • "width": 53.34,
    • "height": 19.91,
    • "length_unit": "cm"

    }

  ]

}

Response samples

• 200
• 400

Content type

application/json

{

• "packages": [

  • {

    • "uuid": "07403398-4dbc-4434-80e4-56f176008d4b",
    • "name": "L",
    • "weight": 1.74,
    • "weight_unit": "lb",
    • "length": 42.55,
    • "width": 53.34,
    • "height": 19.91,
    • "length_unit": "cm"

    }

  ]

}