Packages (0.1)

Download OpenAPI specification:Download

Team Store Fulfillemnt: team-store-fulfillment@newstore.com URL: https://apidocs.newstore.io

Use this API to manage document configuration for in stores functionality for your business.

Packages

Represents the packages configuration for in stores functionality for your business.

Get tenant documents to print configuration

Get documents to print configuration

Get documents to print configuration for a tenant.

Authorizations:

newStoreAccessToken

Responses

Response samples

200

Content type

application/json

{"9c996bd4-4d2b-4fcf-b590-5e80969186c4": {"\*": [{"document_type": "invoice",
"number_of_copies": 1,
"printer_type": "document_printer"
}
]
},
"default": {"in_store_pickup": [{"document_type": "invoice",
"number_of_copies": 1,
"printer_type": "document_printer"
}
],
"\*": [{"document_type": "invoice",
"number_of_copies": 1,
"printer_type": "document_printer"
},
{"document_type": "shipping_label",
"number_of_copies": 1,
"printer_type": "label_printer"
}
]
}
}

Save tenant documents to print configuration

Create documents to print configuration

Use this endpoint to configure the documents you want to print, in your store.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

additional property

object (storeConfig)

The in_store_pickup or * documents to print configuration. The key must be * or a valid in_store_pickup

additional property

Array of objects (documentListConfiguration)

Array

document_type required	string Specifie the document to print, in document_type. NewStore supports invoice, packing_slip, return_form, shipping_label, return_label, and in_store_pickup_label.
number_of_copies required	integer Specifies how many copies to print.
printer_type required	string Specifies the type of printer you want to use, in printer_type. Configure documents to be printed using document_printer and labels to be printed using label_printer.

Responses

Request samples

Payload

Content type

application/json

{"9c996bd4-4d2b-4fcf-b590-5e80969186c4": {"\*": [{"document_type": "invoice",
"number_of_copies": 1,
"printer_type": "document_printer"
}
]
},
"default": {"in_store_pickup": [{"document_type": "invoice",
"number_of_copies": 1,
"printer_type": "document_printer"
}
],
"\*": [{"document_type": "invoice",
"number_of_copies": 1,
"printer_type": "document_printer"
},
{"document_type": "shipping_label",
"number_of_copies": 1,
"printer_type": "label_printer"
}
]
}
}

Response samples

201
400

Content type

application/json

{"9c996bd4-4d2b-4fcf-b590-5e80969186c4": {"\*": [{"document_type": "invoice",
"number_of_copies": 1,
"printer_type": "document_printer"
}
]
},
"default": {"in_store_pickup": [{"document_type": "invoice",
"number_of_copies": 1,
"printer_type": "document_printer"
}
],
"\*": [{"document_type": "invoice",
"number_of_copies": 1,
"printer_type": "document_printer"
},
{"document_type": "shipping_label",
"number_of_copies": 1,
"printer_type": "label_printer"
}
]
}
}