shipstation-client
v0.1.0
Published
ShipStation V2 SDK
Downloads
5
Maintainers
Readme
[email protected]
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 buildPublishing
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 [email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://api.shipstation.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BatchesApi | addToBatch | POST /v2/batches/{batch_id}/add | Add to a batch BatchesApi | createBatch | POST /v2/batches | Create a batch BatchesApi | deleteBatch | DELETE /v2/batches/{batch_id} | Delete batch by id BatchesApi | getBatchByExternalId | GET /v2/batches/external_batch_id/{external_batch_id} | Get batch by external id BatchesApi | getBatchById | GET /v2/batches/{batch_id} | Get batch by id BatchesApi | listBatchErrors | GET /v2/batches/{batch_id}/errors | Get batch errors BatchesApi | listBatches | GET /v2/batches | List batches BatchesApi | processBatch | POST /v2/batches/{batch_id}/process/labels | Process batch id labels BatchesApi | removeFromBatch | POST /v2/batches/{batch_id}/remove | Remove from batch BatchesApi | updateBatch | PUT /v2/batches/{batch_id} | Update batch status to 'archived' by id CarriersApi | getCarrierById | GET /v2/carriers/{carrier_id} | Get carrier by id CarriersApi | getCarrierOptions | GET /v2/carriers/{carrier_id}/options | Get carrier options CarriersApi | listCarrierPackageTypes | GET /v2/carriers/{carrier_id}/packages | List carrier package types CarriersApi | listCarrierServices | GET /v2/carriers/{carrier_id}/services | List carrier services CarriersApi | listCarriers | GET /v2/carriers | List carriers DownloadsApi | downloadFile | GET /v2/downloads/{dir}/{subdir}/{filename} | Download file InventoryApi | addNewInventoryWarehouse | POST /v2/inventory_warehouses | Create a new inventory warehouse InventoryApi | createInventoryLocation | POST /v2/inventory_locations | Create a new inventory location InventoryApi | deleteInventoryLocationById | DELETE /v2/inventory_locations/{inventory_location_id} | Delete an inventory location InventoryApi | deleteInventoryWarehouse | DELETE /v2/inventory_warehouses/{inventory_warehouse_id} | Delete an inventory warehouse InventoryApi | getInventoryLevels | GET /v2/inventory | List SKU inventory levels InventoryApi | getInventoryLocationById | GET /v2/inventory_locations/{inventory_location_id} | Get inventory location by ID InventoryApi | getInventoryWarehouseById | GET /v2/inventory_warehouses/{inventory_warehouse_id} | Get a specific inventory warehouse and related properties using its warehouse ID InventoryApi | getInventoryWarehouses | GET /v2/inventory_warehouses | List all inventory warehouses InventoryApi | listInventoryLocations | GET /v2/inventory_locations | List all inventory locations InventoryApi | updateInventoryLocation | PUT /v2/inventory_locations/{inventory_location_id} | Update an inventory location name InventoryApi | updateInventoryWarehouse | PUT /v2/inventory_warehouses/{inventory_warehouse_id} | Update an inventory warehouse name InventoryApi | updateSKUStockLevels | POST /v2/inventory | Update SKU stock levels and related properties LabelsApi | createLabel | POST /v2/labels | Purchase label LabelsApi | createLabelFromRate | POST /v2/labels/rates/{rate_id} | Purchase label with rate id LabelsApi | createLabelFromShipment | POST /v2/labels/shipment/{shipment_id} | Purchase label with shipment id LabelsApi | createReturnLabel | POST /v2/labels/{label_id}/return | Create a return label LabelsApi | getLabelById | GET /v2/labels/{label_id} | Get label by id LabelsApi | getTrackingLogFromLabel | GET /v2/labels/{label_id}/track | Get label tracking information LabelsApi | listLabels | GET /v2/labels | List labels LabelsApi | voidLabel | PUT /v2/labels/{label_id}/void | Void a label by id ManifestsApi | createManifest | POST /v2/manifests | Create manifest ManifestsApi | getManifestById | GET /v2/manifests/{manifest_id} | Get manifest by id ManifestsApi | listManifests | GET /v2/manifests | List manifests PackagePickupsApi | deleteScheduledPickup | DELETE /v2/pickups/{pickup_id} | Delete a scheduled pickup PackagePickupsApi | getPickupById | GET /v2/pickups/{pickup_id} | Get pickup by id PackagePickupsApi | listScheduledPickups | GET /v2/pickups | List scheduled pickups PackagePickupsApi | schedulePickup | POST /v2/pickups | Schedule a pickup PackageTypesApi | createPackageType | POST /v2/packages | Create custom package type PackageTypesApi | deletePackageTyp | DELETE /v2/packages/{package_id} | Delete a custom package by id PackageTypesApi | getPackageTypeById | GET /v2/packages/{package_id} | Get custom package type by id PackageTypesApi | listPackageTypes | GET /v2/packages | List custom package types PackageTypesApi | updatePackageType | PUT /v2/packages/{package_id} | Update custom package type by id RatesApi | calculateRates | POST /v2/rates | Get shipping rates RatesApi | estimateRates | POST /v2/rates/estimate | Estimate rates RatesApi | getRateById | GET /v2/rates/{rate_id} | Get rate by id ShipmentsApi | cancelShipments | PUT /v2/shipments/{shipment_id}/cancel | Cancel a shipment ShipmentsApi | getShipmentByExternalId | GET /v2/shipments/external_shipment_id/{external_shipment_id} | Get shipment by external id ShipmentsApi | getShipmentById | GET /v2/shipments/{shipment_id} | Get shipment by id ShipmentsApi | listShipmentRates | GET /v2/shipments/{shipment_id}/rates | Get shipment rates ShipmentsApi | listShipments | GET /v2/shipments | List shipments ShipmentsApi | tagShipment | POST /v2/shipments/{shipment_id}/tags/{tag_name} | Add tag to shipment ShipmentsApi | untagShipment | DELETE /v2/shipments/{shipment_id}/tags/{tag_name} | Remove tag from shipment TagsApi | createTag | POST /v2/tags/{tag_name} | Create a new tag TagsApi | listTags | GET /v2/tags | Get tags TrackingApi | stopTracking | POST /v2/tracking/stop | Stop tracking a package WarehousesApi | getWarehouseById | GET /v2/warehouses/{warehouse_id} | Get warehouse by id WarehousesApi | listWarehouses | GET /v2/warehouses | List warehouses WebhooksApi | createWebhook | POST /v2/environment/webhooks | Create a webhook WebhooksApi | deleteWebhook | DELETE /v2/environment/webhooks/{webhook_id} | Delete webhook by id WebhooksApi | getWebhookById | GET /v2/environment/webhooks/{webhook_id} | Get webhook by id WebhooksApi | listWebhooks | GET /v2/environment/webhooks | List webhooks WebhooksApi | updateWebhook | PUT /v2/environment/webhooks/{webhook_id} | Update a webhook
Documentation For Models
- AddNewInventoryWarehouseRequest
- AddToBatchRequestBody
- Address
- AddressResidentialIndicator
- AddressValidatingShipment
- AddressValidationCode
- AddressValidationDetailCode
- AddressValidationMessageType
- AddressValidationResult
- AddressValidationStatus
- AdvancedShipmentOptions
- AdvancedShipmentOptionsDangerousGoodsContact
- AdvancedShipmentOptionsFedexFreight
- AdvancedShipmentOptionsWindsorFrameworkDetails
- AlternativeIdentifier
- Batch
- BatchResponseError
- BatchStatus
- BatchesSortBy
- BillToParty
- CalculateRatesRequestBody
- CalculateRatesResponseBody
- Carrier
- CarrierAdvancedOption
- CollectOnDelivery
- CollectOnDeliveryPaymentType
- ContactDetails
- CreateAndProcessBatchRequestBody
- CreateAndProcessBatchRequestBodyProcessLabels
- CreateAndValidateShipment
- CreateBatchRequest
- CreateBatchRequestBody
- CreateBatchResponseBody
- CreateInventoryLocationRequest
- CreateLabelFromRateRequestBody
- CreateLabelFromRateResponseBody
- CreateLabelFromShipmentRequestBody
- CreateLabelFromShipmentResponseBody
- CreateLabelRequestBody
- CreateLabelResponseBody
- CreateManifestByObjectRequestBody
- CreateManifestLabelIdsRequestBody
- CreateManifestRequestBody
- CreateManifestResponseBody
- CreatePackageTypeRequestBody
- CreatePackageTypeResponseBody
- CreateReturnLabelRequestBody
- CreateReturnLabelResponseBody
- CreateTagResponseBody
- CreateWebhookRequestBody
- CreateWebhookResponseBody
- CustomsItem
- DangerousAmount
- DangerousGoods
- DeletePickupByIdResponseBody
- DeleteScheduledPickupResponseBody
- DeliveryConfirmation
- DeprecatedManifest
- DimensionUnit
- Dimensions
- DisplayScheme
- ErrorCode
- ErrorResponseBody
- ErrorSource
- ErrorType
- ErrorWithLabelId
- ErrorWithLabelIdResponseBody
- EstimateRatesRequestBody
- EstimatedImportCharges
- GetBatchByExternalIdResponseBody
- GetBatchByIdResponseBody
- GetCarrierByIdResponseBody
- GetCarrierOptionsResponseBody
- GetCarriersResponseBody
- GetInventoryLevels200Response
- GetInventoryLevels200ResponseInventoryInner
- GetInventoryLevels200ResponseInventoryInnerAverageCost
- GetInventoryLevels200ResponseLinks
- GetInventoryLevels200ResponseLinksFirst
- GetInventoryWarehouses200Response
- GetInventoryWarehouses200ResponseInventoryWarehousesInner
- GetLabelByIdResponseBody
- GetManifestByIdResponseBody
- GetPackageTypeByIdResponseBody
- GetPickupByIdResponseBody
- GetPickupsResponseBody
- GetRateByIdResponseBody
- GetShipmentByExternalIdResponseBody
- GetShipmentByIdResponseBody
- GetTrackingLogFromLabelResponseBody
- GetWarehouseByIdResponseBody
- GetWebhookByIdResponseBody
- IdentifierType
- ImporterOfRecords
- InsuranceProvider
- InternationalShipmentOptions
- InvoiceAdditionalDetails
- Label
- LabelChargeEvent
- LabelDownload
- LabelDownloadType
- LabelFormat
- LabelLayout
- LabelMessages
- LabelPackage
- LabelPackagesInner
- LabelStatus
- LabelVoidFailureReason
- Link
- ListBatchErrorsResponseBody
- ListBatchesResponseBody
- ListCarrierPackageTypesResponseBody
- ListCarrierServicesResponseBody
- ListCarriersResponseBody
- ListInventoryLocations200Response
- ListInventoryLocations200ResponseInventoryLocationsInner
- ListLabelsResponseBody
- ListManifestsResponseBody
- ListPackageTypesResponseBody
- ListPickupResponseBody
- ListShipmentRatesResponseBody
- ListShipmentsResponseBody
- ListTagsResponseBody
- ListWarehousesResponseBody
- Manifest
- ManifestDownload
- ManifestRequestStatus
- ManifestRequests
- Manifests
- ModelError
- ModifyBatch
- MonetaryValue
- NonDelivery
- OptionalLink
- OrderSourceName
- OriginType
- Package
- PackageContents
- PackageType
- PagedListResponseBody
- PaginationLink
- PaperlessDownload
- PartialAddress
- PartialShipment
- PartialShippingAddress
- PartialShippingAddressTo
- PartialShippingAddressToGeolocationInner
- PaymentAmount
- Pickup
- PickupPickupWindowsInner
- PickupResponseBody
- PickupWindow
- ProcessBatchRequestBody
- Products
- PurchaseLabelWithoutShipment
- Rate
- RateEstimate
- RateEstimateByCarrierId
- RateEstimateByCarrierIds
- RateRequestBody
- RateResponseStatus
- RateType
- RatesInformation
- RemoveFromBatchRequestBody
- ResponseMessage
- SchedulePickupRequestBody
- SchedulePickupResponseBody
- SchedulePickupResponseBody1
- Service
- Shipment
- ShipmentIdRequest
- ShipmentItem
- ShipmentRequest
- ShipmentStatus
- ShipmentsSortBy
- ShippingAddress
- ShippingAddressTo
- SortDir
- Tag
- TagShipmentResponseBody
- TaxIdentifier
- TaxableEntityType
- TermsOfTradeCode
- TrackEvent
- TrackingInformation
- TrackingStatus
- TrackingStatusDetailCode
- UpdateInventoryWarehouseRequest
- UpdatePackageTypeRequestBody
- UpdateSKUStockLevelsRequest
- UpdateSKUStockLevelsRequestNewCost
- UpdateWebhookRequestBody
- ValidateAddress
- ValidationStatus
- VoidLabelResponseBody
- Warehouse
- Webhook
- WebhookEvent
- WebhookHeader
- Weight
- WeightUnit
- Weigth
Documentation For Authorization
Authentication schemes defined for the API:
api_keys
- Type: API key
- API key parameter name: api-key
- Location: HTTP header
