@teemill/fulfillments

@teemill/fulfillments@1.62.0

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @teemill/fulfillments@1.62.0 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.localhost:8080

Class	Method	HTTP request	Description
FulfillmentsApi	assignFulfillmentApplicationPrintProfile	PUT /v1/fulfillments/styles/{styleId}/applications/{applicationId}/print-profiles/{profileId}	Assign a print profile
FulfillmentsApi	cancelShipment	DELETE /v1/fulfillments/{fulfillmentId}/shipment	Cancel shipment
FulfillmentsApi	createChatChannel	POST /v1/fulfillments/{fulfillmentId}/chat-channel	Create chat channel
FulfillmentsApi	createFulfillmentShippingUpdate	POST /v1/fulfillments/shipping-updates	Create shipping update
FulfillmentsApi	createFulfillmentSubTask	POST /v1/fulfillments/sub-tasks	Create fulfillment sub task
FulfillmentsApi	createShipment	POST /v1/fulfillments/{fulfillmentId}/shipment	Create shipment
FulfillmentsApi	deleteFulfillmentSubTask	DELETE /v1/fulfillments/sub-tasks/{subTaskId}	Delete fulfillment sub task
FulfillmentsApi	downloadFulfillmentJobsheet	GET /v1/fulfillments/{fulfillmentId}/jobsheet	Download fulfillment jobsheet
FulfillmentsApi	exportFulfillments	GET /v1/fulfillments/export	Export fulfillments
FulfillmentsApi	exportMetrics	GET /v1/fulfillments/metrics/export	Export metrics
FulfillmentsApi	getFulfillment	GET /v1/fulfillments/{fulfillmentId}	Get fulfillment
FulfillmentsApi	getFulfillmentShippingUpdates	GET /v1/fulfillments/{fulfillmentId}/shipping-updates	Get shipping updates
FulfillmentsApi	getFulfillmentSubTask	GET /v1/fulfillments/sub-tasks/{subTaskId}	Get fulfillment sub task
FulfillmentsApi	getLog	GET /v1/fulfillments/{fulfillmentId}/logs/{logId}	Get log
FulfillmentsApi	getLogs	GET /v1/fulfillments/{fulfillmentId}/logs	Get action logs
FulfillmentsApi	getShipment	GET /v1/fulfillments/{fulfillmentId}/shipment	Get shipment
FulfillmentsApi	listAvailableShippingMethods	GET /v1/fulfillments/{fulfillmentId}/available-shipping-methods	List available shipping methods
FulfillmentsApi	listFulfillmentApplicationPrintProfiles	GET /v1/fulfillments/styles/{styleId}/applications/{applicationId}/print-profiles	List assigned print profiles
FulfillmentsApi	listFulfillmentSubTasks	GET /v1/fulfillments/sub-tasks	List fulfillment sub tasks
FulfillmentsApi	listFulfillments	GET /v1/fulfillments	List fulfillments
FulfillmentsApi	listProductTypes	GET /v1/fulfillments/product-types	List product types
FulfillmentsApi	listTechnologies	GET /v1/fulfillments/technologies	List technologies
FulfillmentsApi	printFulfillmentItemLabel	GET /v1/fulfillments/{fulfillmentId}/items/{itemId}/print	Prints the label for a specific fulfillment item
FulfillmentsApi	printFulfillmentStyleApplication	POST /v1/fulfillments/styles/{styleId}/applications/{applicationId}/print	Print a fulfillment style application
FulfillmentsApi	removeFulfillmentApplicationPrintProfile	DELETE /v1/fulfillments/styles/{styleId}/applications/{applicationId}/print-profiles/{profileId}	Remove a print profile
FulfillmentsApi	splitFulfillment	POST /v1/fulfillments/{fulfillmentId}/split	Split fulfillment
FulfillmentsApi	updateFulfillment	PATCH /v1/fulfillments/{fulfillmentId}	Update fulfillment
FulfillmentsApi	updateFulfillmentItem	PATCH /v1/fulfillments/{fulfillmentId}/items/{itemId}	Update a fulfillment item
FulfillmentsApi	updateFulfillmentStyleApplication	PATCH /v1/fulfillments/styles/{styleId}/applications/{applicationId}	Update a fulfillment style application
FulfillmentsApi	updateFulfillmentSubTask	PATCH /v1/fulfillments/sub-tasks/{subTaskId}	Update fulfillment sub task
PackslipsApi	getPackslip	GET /v1/fulfillments/{fulfillmentId}/packslips/{packslipId}	Get a packslip
PackslipsApi	printPackslip	GET /v1/fulfillments/{fulfillmentId}/packslips/{packslipId}/print	Print a packslip

Documentation For Models

• Address
• ApiError
• Application
• AttachedFile
• ContactInformation
• CreateChatChannel200Response
• CreateFulfillmentSubTaskRequest
• CreateShippingUpdate
• DeliveryEstimates
• Dimensions
• ExportFulfillments202Response
• Fulfillment
• FulfillmentAddressState
• FulfillmentItem
• FulfillmentItemMetadata
• FulfillmentLogs
• FulfillmentPackslip
• FulfillmentSubTask
• FulfillmentsResponse
• FulfillmentsResponseMeta
• FulfillmentsResponseMetaFilters
• ListAvailableShippingMethods200Response
• ListFulfillmentSubTasks200Response
• ListProductTypes200Response
• ListTechnologies200Response
• Log
• PackingInstructions
• PackingNote
• Platform
• Price
• PrintArea
• PrintProfileAssignment
• PrintProfileAssignmentList
• PriorityLevel
• ProductType
• QualityCheck
• Shipment
• ShippingMethod
• ShippingUpdate
• ShippingUpdateLocation
• ShippingUpdateStatus
• ShippingUpdateSubStatus
• SplitFulfillmentRequest
• Status
• StatusHistoryItem
• Technology
• TemplateProperties
• Tracking
• UpdateFulfillmentItemRequest
• UpdateFulfillmentRequest
• UpdateFulfillmentRequestAdditionalFilesInner
• UpdateFulfillmentStyleApplicationRequest
• UpdateFulfillmentStyleApplicationRequestDimensions
• UpdateFulfillmentSubTaskRequest

Documentation For Authorization

Authentication schemes defined for the API:

api-key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

session-oauth

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A