shipwire.receivings
Module shipwire.receivings
Definitions
ballerinax/shipwire.receivings Ballerina library
Overview
Shipwire is an order fulfillment and logistics platform that manages inventory across Shipwire and Shipwire Anywhere warehouses.
The Shipwire Receivings connector lets Ballerina applications manage receiving orders (advance ship notices) through version 3 of the Shipwire Receivings API. It supports creating, updating, listing, cancelling and completing receivings, and reading their items, holds, shipments, trackings, labels and instruction recipients.
Key features
- Create and update advance ship notices for Shipwire and Shipwire Anywhere warehouses
- List and retrieve receiving orders with optional filters and expanded data
- Cancel receiving orders and receiving labels
- Mark receivings as complete
- Inspect receiving items, holds, shipments, trackings, labels and instruction recipients
Setup guide
To use the Shipwire Receivings connector you need a Shipwire account with API access.
-
Sign in to your Shipwire account, or create one at shipwire.com.
-
Make sure the account user you will authenticate with has permission to manage receivings.
-
Note the username (email) and password of that user. The connector authenticates with HTTP basic authentication using these credentials.
Quickstart
To use the shipwire.receivings connector in your Ballerina application, update the .bal file as follows:
-
Import the
shipwire.receivingsmodule.import ballerinax/shipwire.receivings; -
Create a
Config.tomlfile with your credentials.username = "<Shipwire username>" password = "<Shipwire password>" -
Create a
receivings:ConnectionConfigand initialize the client.configurable string username = ?; configurable string password = ?; final receivings:Client shipwire = check new ({ auth: { username, password } }); -
Invoke the connector operation.
public function main() returns error? { receivings:ListReceivingsResponse _ = check shipwire->listReceivings(); }
Examples
The Shipwire Receivings connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Receiving status report - Retrieve a receiving order together with its items and holds.
- Advance notice lifecycle - Create an advance ship notice and optionally cancel it.
Clients
shipwire.receivings: Client
Allows managing inventory at Shipwire and Shipwire Anywhere warehouses using receiving orders
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.shipwire.com/api" - URL of the target service
listReceivings
function listReceivings(map<string|string[]> headers, *ListReceivingsQueries queries) returns ListReceivingsResponse|errorGet list of advance ship notices
Parameters
- queries *ListReceivingsQueries - Queries to be sent with the request
Return Type
createReceiving
function createReceiving(CreateReceivingRequest payload, map<string|string[]> headers, *CreateReceivingQueries queries) returns CreateReceivingResponse|errorCreate an advance ship notice
Parameters
- payload CreateReceivingRequest - Receiving order details to create, including items, shipping and routing
- queries *CreateReceivingQueries - Queries to be sent with the request
Return Type
getReceiving
function getReceiving(string id, map<string|string[]> headers, *GetReceivingQueries queries) returns ReceivingResponse|errorGet advance ship notice
Parameters
- id string - The advance ship notice's ID
- queries *GetReceivingQueries - Queries to be sent with the request
Return Type
- ReceivingResponse|error - OK
updateReceiving
function updateReceiving(string id, CreateReceivingRequest payload, map<string|string[]> headers, *UpdateReceivingQueries queries) returns ReceivingResponse|errorUpdate an advance ship notice
Parameters
- id string - The advance ship notice's ID
- payload CreateReceivingRequest - Receiving order fields to update
- queries *UpdateReceivingQueries - Queries to be sent with the request
Return Type
- ReceivingResponse|error - OK
cancelReceiving
function cancelReceiving(string id, map<string|string[]> headers) returns CancelReceivingResponse|errorCancel a receiving order
Parameters
- id string - The advance ship notice's ID
Return Type
cancelReceivingLabels
function cancelReceivingLabels(string id, map<string|string[]> headers) returns CancelReceivingLabelsResponse|errorCancel a receiving label
Parameters
- id string - The advance ship notice's ID
Return Type
listReceivingHolds
function listReceivingHolds(string id, map<string|string[]> headers, *ListReceivingHoldsQueries queries) returns ReceivingHoldsResponse|errorGet holds detail
Parameters
- id string - The advance ship notice's ID
- queries *ListReceivingHoldsQueries - Queries to be sent with the request
Return Type
listReceivingInstructionsRecipients
function listReceivingInstructionsRecipients(string id, map<string|string[]> headers) returns ReceivingInstructionsRecipientsResponse|errorGet instructions and the recipients contact details
Parameters
- id string - The advance ship notice's ID
Return Type
listReceivingExtendedAttributes
function listReceivingExtendedAttributes(string id, map<string|string[]> headers) returns ReceivingExtendedAttributesResponse|errorGet receiving extended attributes
Parameters
- id string - The receiving's ID
Return Type
listReceivingItems
function listReceivingItems(string id, map<string|string[]> headers) returns ReceivingItemsResponse|errorGet items detail
Parameters
- id string - The advance ship notice's ID
Return Type
listReceivingShipments
function listReceivingShipments(string id, map<string|string[]> headers) returns ReceivingShipmentsResponse|errorGet shipment details
Parameters
- id string - The advance ship notice's ID
Return Type
listReceivingTrackings
function listReceivingTrackings(string id, map<string|string[]> headers) returns ReceivingTrackingsResponse|errorGet trackings detail
Parameters
- id string - The advance ship notice's ID
Return Type
listReceivingLabels
function listReceivingLabels(string id, map<string|string[]> headers) returns ReceivingLabelsResponse|errorGet labels detail
Parameters
- id string - The advance ship notice's ID
Return Type
markReceivingComplete
function markReceivingComplete(string id, map<string|string[]> headers) returns MarkReceivingCompleteResponse|errorMark the receiving completed
Parameters
- id string - The advance ship notice's ID
Return Type
Records
shipwire.receivings: AddressResource
Fields
- country? string - Country from where the inventory is shipped
- address3? string - This is the third line of the address of the shipper
- address2? string - This is the second line of the address of the shipper
- city? string - City from where the inventory is shipped
- phone? string - Contact phone number of the shipper for any communication
- address1? string - This is the first line of the address of the shipper
- postalCode? string - Postal code of the area from where the inventory is shipped
- name? string - Name of the shipper
- state? string - State from where the inventory is shipped
- email? string - Email address of the shipper. i.e. the merchant sending inventory to the Shipwire warehouse
shipwire.receivings: Arrangement
The arrangement type tells Shipwire what further actions to take once the advance ship notice is created
Fields
- phone? string - Contact phone number of the person from Shipwire system responsible for coordinating with the carrier or supplier for arranging delivery if needed
- contact? string - Contact name of the person from Shipwire system responsible for coordinating with the carrier or supplier for arranging delivery if needed
- 'type? "none"|"overseas"|"label"|"pickup"|"ltlpickup"|"portpickup" - The arrangement type, which tells Shipwire how the shipment will be delivered to the warehouse
shipwire.receivings: CancelReceivingLabelsResponse
Fields
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- message? string - This is the HTTP status message
- status? Signed32 - This is the HTTP status code
shipwire.receivings: CancelReceivingResponse
Fields
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- message? string - This is the HTTP status message
- status? Signed32 - This is the HTTP status code
shipwire.receivings: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
shipwire.receivings: CreateReceivingItem
Item being shipped to Shipwire
Fields
- orderExternalId? string - This is the receving order ID in the external system on which the hold is applied
- inReview? int - The number of SKU items currently under review within the warehouse. (i.e. items being reviewed to determine if they are in sellable condition or damaged, etc.)
- quantity? int - The quantity of total SKU items belonging to the particular lot
- productId? int - A unique auto-generated ID assigned to each new product added to the Shipwire Product Catalog
- orderId? int - This is the receving order ID in the shipwire system on which the hold is applied
- productExternalId? string - A unique user-provided identifier for a product in an external system
- expected? int - The total number of SKU items expected to be received at the warehouse as per the order
- pending? int - The number of pending SKU items expected to be received at the warehouse
- damaged? int - The number of SKU items found to be damaged (during receiving or otherwise) within the warehouse and unavailable for fulfillment
- id? int - A unique auto-generated ID assigned to each new line item added to the Shipwire Platform
- sku? string - SKU (Stock Keeping Unit) is a unique name for your product and is required for both physical and virtual products in inventory
- good? int - The number of SKU items ready for fulfillment in the warehouse
shipwire.receivings: CreateReceivingQueries
Represents the Queries record for the operation: createReceiving
Fields
- expand? ("holds"|"instructionsRecipients"|"items"|"shipments"|"labels"|"trackings"|"all")[] - Expand receivings data in the response, instead of accessing directly via a URL (comma separated list). See resources
Holds,Instruction Recipients,Items,Shipments,labelsandTrackingsfor information on the data model returned by this parameter
shipwire.receivings: CreateReceivingRequest
Fields
- arrangement Arrangement - The arrangement type tells Shipwire what further actions to take once the advance ship notice is created
- shipFrom AddressResource -
- orderNo? string - Purchase Order number associated with the Advance Shipping Notice
- trackings? Tracking[] - Specifies shipment tracking details. See
trackingsresource
- options OptionsResource -
- externalId? string - Unique ID of the Advance Shipping Notice in an external system
- expectedDate? string - Date on which the Advance Shipping Notice is expected to arrive at the Shipwire warehouse
- shipments Shipment -
- items CreateReceivingItem[] - Items being shipped to Shipwire
- extendedAttributes? ExtendedAttributes[] - Extended attributes of the advance ship notice
- labels? Label -
- instructionsRecipients? InstructionsRecipient[] -
shipwire.receivings: CreateReceivingResponse
Fields
- Fields Included from *ReceivingServerResponse
- Fields Included from *ListReceivingsResponseOffset
- anydata...
- Fields Included from *CreateReceivingResponseResource
- anydata...
- Fields Included from *CreateReceivingResponseResourceItems
- resource ReceivingItemsResource
- anydata...
shipwire.receivings: CreateReceivingResponseResource
Gets List Of Advance Ship Notices
shipwire.receivings: CreateReceivingResponseResourceItems
Fields
- 'resource? ReceivingItemsResource -
shipwire.receivings: ExtendedAttributes
Fields
- name? string - Name of the extended attribute i.e. any additional information as per the customer request to be added in the receiving order. (e.g. return instructions)
- 'type? string - Data type of the extended attribute value i.e. a string or integer
- value? string - Value of the extended attribute which depends on the customer request. (e.g. For return instructions the value can be mail in or store)
shipwire.receivings: GetReceivingQueries
Represents the Queries record for the operation: getReceiving
Fields
- expand? ("holds"|"instructionsRecipients"|"items"|"shipments"|"labels"|"trackings"|"all")[] - Expand receivings data in the response, instead of accessing directly via a URL (comma separated list). See resources
Holds,Instruction Recipients,Items,Shipments,labelsandTrackingsfor information on the data model returned by this parameter
shipwire.receivings: InstructionsRecipient
Fields
- note? string - May be used to provide instructions to recipient on how to process and store received inventory
- name? string - Name of individual responsible for processing order/inventory at receiving facility
- email? string - Email address of individual responsible for processing order/inventory at receiving facility
shipwire.receivings: Label
Fields
- orderExternalId? string - This is the receving order ID in the external system on which the hold is applied
- labelId? int - A unique ID assigned to each shipping label in the shipwire system
- orderId? int - This is the receving order ID in the shipwire system on which the hold is applied
shipwire.receivings: ListReceivingHoldsQueries
Represents the Queries record for the operation: listReceivingHolds
Fields
- includeCleared? 0|1 - When set to 1, response includes holds that have been cleared
shipwire.receivings: ListReceivingsQueries
Represents the Queries record for the operation: listReceivings
Fields
- expand? ("holds"|"instructionsRecipients"|"items"|"shipments"|"labels"|"trackings"|"all")[] - Expand receivings data in the response, instead of accessing directly via a URL (comma separated list). See resources
Holds,Instruction Recipients,Items,Shipments,labelsandTrackingsfor information on the data model returned by this parameter
- updatedAfter? string - Only show resources updated after this date (ISO 8601 format, ex: "2014-05-30T13:08:29-07:00")
- commerceName? string - Filter by commerceName (comma separated list)
- orderNo? string - Filter by orderNo (comma separated list)
- orderId? string - Filter by orderId (comma separated list)
- warehouseId? string - Filter by warehouseId (comma separated list)
- vendorExternalId? string - Filter by vendorExternalId
- externalId? string - Filter by externalId (comma separated list)
- vendorId? string - Filter by vendorId
- warehouseExternalId? string - Filter by warehouseExternalId (comma separated list)
- transactionId? string - Filter by transactionId (comma separated list)
- status? "processed"|"canceled"|"completed"|"delivered"|"returned"|"submitted"|"held"|"tracked" - Filter by status (comma separated list)
shipwire.receivings: ListReceivingsResponse
Fields
- Fields Included from *ReceivingServerResponse
- Fields Included from *ListReceivingsResponseItems
- anydata...
- Fields Included from *ListReceivingsResponseResource
- anydata...
- Fields Included from *ListReceivingsResponseResourceItems
- resource record { anydata... }
- anydata...
shipwire.receivings: ListReceivingsResponseItems
shipwire.receivings: ListReceivingsResponseOffset
shipwire.receivings: ListReceivingsResponseResource
Gets List Of Advance Ship Notices
shipwire.receivings: ListReceivingsResponseResourceItems
Fields
- 'resource? record {} -
shipwire.receivings: MarkReceivingCompleteResponse
Mark the receiving as completed
Fields
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? Signed32 - This is the HTTP status code
shipwire.receivings: OptionsResource
Fields
- warehouseRegion? string - This is the place where the warehouse is located
- warehouseId? Signed32 - A unique identifier for a Shipwire or Shipwire Anywhere warehouse
- doNotSendEmail? int - A boolean which indicates whether or not the warehouse sends ASN related emails on events such as creation, delivery. The value '1' (True) means that the emails will not be sent
- warehouseExternalId? string - A unique user-provided identifier for a Shipwire Anywhere warehouse in an external system
shipwire.receivings: ReceivingExtendedAttributesResource
Fields
- next? string - A link used to fetch the next set or page of items in the API response
- total? int - Total number of available items in the API response
- offset? int - This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30
- previous? string - A link used to fetch the previous set or page of items in the API response
- items? ReceivingExtendedAttributesResourceItems[] -
shipwire.receivings: ReceivingExtendedAttributesResourceItems
Fields
- 'resource? ExtendedAttributes -
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: ReceivingExtendedAttributesResponse
Get receiving extended attributes response
Fields
- 'resource? ReceivingInstructionsRecipientsResponseResource - The extended attributes of the receiving
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? int - This is the HTTP status code
shipwire.receivings: ReceivingHold
Holds that apply to this advance ship notice
Fields
- orderId? int - This is the receving order ID in the shipwire system on which the hold is applied
- description? string - This is the description given for the hold in the Shipwire system
- appliedDate? string - This is the date on which the hold is applied to the order
- clearedDate? string - This is the date on which the hold is removed from the order
- id? int - This is the unique ID assigned to a particular hold in the shipwire system
- externalOrderId? string - This is the receving order ID in the external system on which the hold is applied
- 'type? string - This is the type of hold due to which the order is stuck. (e.g. customer, admin, etc.)
shipwire.receivings: ReceivingHoldsResourceItems
Fields
- 'resource? ReceivingHold - Holds that apply to this advance ship notice
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: ReceivingHoldsResponse
Get instructions recipients details response
Fields
- 'resource? ReceivingHoldsResponseResource - The holds placed on the receiving, with links to each hold
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? int - This is the HTTP status code
shipwire.receivings: ReceivingHoldsResponseResource
Fields
- next? string - A link used to fetch the next set or page of items in the API response
- total? int - Total number of available items in the API response
- offset? int - This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30
- previous? string - A link used to fetch the previous set or page of items in the API response
- items? ReceivingHoldsResourceItems[] -
shipwire.receivings: ReceivingInstructionsRecipientsResponse
Get instructions recipients details response
Fields
- 'resource? ReceivingInstructionsRecipientsResponseResource - The instructions and recipients contact details of the receiving
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? int - This is the HTTP status code
shipwire.receivings: ReceivingInstructionsRecipientsResponseResource
Fields
- next? string - A link used to fetch the next set or page of items in the API response
- total? int - Total number of available items in the API response
- offset? int - This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30
- previous? string - A link used to fetch the previous set or page of items in the API response
shipwire.receivings: ReceivingInstructionsRecipientsResponseResourceItems
Fields
- 'resource? record {} -
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: ReceivingItem
Item being shipped to Shipwire
Fields
- inReview? int - The number of SKU items currently under review within the warehouse. (i.e. items being reviewed to determine if they are in sellable condition or damaged, etc.)
- quantity? int - The quantity of total SKU items belonging to the particular lot
- productId? int - A unique auto-generated ID assigned to each new product added to the Shipwire Product Catalog
- orderId? int - This is the receving order ID in the shipwire system on which the hold is applied
- expected? int - The total number of SKU items expected to be received at the warehouse as per the order
- pending? int - The number of pending SKU items expected to be received at the warehouse
- lotControl? ReceivingItemLotControl - Lot control details (lot, expiration date and quantity) of the item
- good? int - The number of SKU items ready for fulfillment in the warehouse
- extendedAttributes? ReceivingItemExtendedAttributes - Extended attributes of the item
- orderExternalId? string - This is the receving order ID in the external system on which the hold is applied
- productExternalId? string - A unique user-provided identifier for a product in an external system
- damaged? int - The number of SKU items found to be damaged (during receiving or otherwise) within the warehouse and unavailable for fulfillment
- id? int - A unique auto-generated ID assigned to each new line item added to the Shipwire Platform
- sku? string - SKU (Stock Keeping Unit) is a unique name for your product and is required for both physical and virtual products in inventory
shipwire.receivings: ReceivingItemExtendedAttributes
Fields
- 'resource? ReceivingExtendedAttributesResource -
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: ReceivingItemLotControl
Fields
- 'resource? ReceivingLotControlResource -
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: ReceivingItemsResource
Fields
- next? string - A link used to fetch the next set or page of items in the API response
- total? int - Total number of available items in the API response
- offset? int - This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30
- previous? string - A link used to fetch the previous set or page of items in the API response
- items? ReceivingItemsResourceItems[] -
shipwire.receivings: ReceivingItemsResourceItems
Fields
- 'resource? ReceivingItem - Item being shipped to Shipwire
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: ReceivingItemsResponse
Get items details response
Fields
- 'resource? ReceivingInstructionsRecipientsResponseResource - The items being shipped to Shipwire in the receiving
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? int - This is the HTTP status code
shipwire.receivings: ReceivingLabelsResponse
Get labels details response
Fields
- 'resource? ReceivingLabelsResponseResource - The shipping labels of the receiving
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? int - This is the HTTP status code
shipwire.receivings: ReceivingLabelsResponseResource
Fields
- next? string - A link used to fetch the next set or page of items in the API response
- total? int - Total number of available items in the API response
- offset? int - This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30
- previous? string - A link used to fetch the previous set or page of items in the API response
- items? ReceivingLabelsResponseResourceItems[] -
shipwire.receivings: ReceivingLabelsResponseResourceItems
Fields
- 'resource? record {} -
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: ReceivingLotControl
Fields
- quantity? int - The quantity of total SKU items belonging to the particular lot
- lotId? string - A unique ID assigned to a particular quantity or lot of material shipped from a siingle merchant
- expirationDate? string - This is the expiry date of the product belonging to the particular lot
shipwire.receivings: ReceivingLotControlResource
Fields
- next? string - A link used to fetch the next set or page of items in the API response
- total? int - Total number of available items in the API response
- offset? int - This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30
- previous? string - A link used to fetch the previous set or page of items in the API response
- items? ReceivingLotControlResourceItems[] -
shipwire.receivings: ReceivingLotControlResourceItems
Fields
- 'resource? ReceivingLotControl -
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: ReceivingResponse
Fields
- 'resource? record {} -
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? int - This is the HTTP status code
shipwire.receivings: ReceivingServerResponse
Receiving Server Response
Fields
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? int - This is the HTTP status code
shipwire.receivings: ReceivingShipmentsResponse
Get shipment details response
Fields
- 'resource? ReceivingShipmentsResponseResource - The shipments of the receiving
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? int - This is the HTTP status code
shipwire.receivings: ReceivingShipmentsResponseResource
Fields
- next? string - A link used to fetch the next set or page of items in the API response
- total? int - Total number of available items in the API response
- offset? int - This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30
- previous? string - A link used to fetch the previous set or page of items in the API response
- items? ReceivingShipmentsResponseResourceItems[] -
shipwire.receivings: ReceivingShipmentsResponseResourceItems
Fields
- 'resource? record {} -
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: ReceivingTrackingsResponse
Get trackings details response
Fields
- 'resource? ReceivingTrackingsResponseResource - The shipment trackings of the receiving
- message? string - This is the HTTP status message
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
- status? int - This is the HTTP status code
shipwire.receivings: ReceivingTrackingsResponseResource
Fields
- next? string - A link used to fetch the next set or page of items in the API response
- total? int - Total number of available items in the API response
- offset? int - This is an integer that matches the offset given in the request and dictates the number of items to skip while fetching results. For example, there is a preset limit of 20 results per page. If there are 30 total results and offset is set to 20, then the response will show the second "page" of results, with items 21 to 30
- previous? string - A link used to fetch the previous set or page of items in the API response
- items? ReceivingTrackingsResponseResourceItems[] -
shipwire.receivings: ReceivingTrackingsResponseResourceItems
Fields
- 'resource? record {} -
- resourceLocation? string - A URL that gives more information about the linked resource. A 'null' value would mean that no further information is available for that resource
shipwire.receivings: Shipment
Fields
- shipmentId? int - A unique ID assigned to the shipment (container) in the shipwire system
- length? decimal - This is the length of the shipment (container) based on its Unit of Measurement
- width? decimal - This is the width of the shipment (container) based on its Unit of Measurement
- weight? decimal - This is the weight of the shipment (container) based on its Unit of Measurement
- 'type? string - Type of the shipment (container) based on the contents stored in it (e.g. a box, parcel, etc.)
- height? decimal - This is the height of the shipment (container) based on its Unit of Measurement
shipwire.receivings: Tracking
Fields
- summary? string - Summary added to the tracking record for tracking purposes
- labelCreationDate? string - Date on which the shipping labels are created for the tracking record
- orderId? int - This is the receving order ID in the shipwire system on which the hold is applied
- summaryDate? string - Date on which the summary is added to the tracking record
- tracking? string - This is reference tracking number provided by the carrier for tracking purposes
- url? string - A URL that gives more information about the tracking record
- orderExternalId? string - This is the receving order ID in the external system on which the hold is applied
- carrier? string - This is the unique ID of the carrier used to deliver the order to the warehouse
- firstScanDate? string - Date the order's associated shipping carrier scans the label when it receives the order
- phone? string - Phone number of the contact person from the carrier company for any communication
- trackedDate? string -
- contact? string - Name of person from the carrier company who can be contacted for any communication
- id? int - This is the unquie ID generated in the shipwire system for each tracking record
- delivered1Date? string - Date on which the the inventory is received against the tracking record
shipwire.receivings: UpdateReceivingQueries
Represents the Queries record for the operation: updateReceiving
Fields
- expand? ("holds"|"instructionsRecipients"|"items"|"shipments"|"labels"|"trackings"|"all")[] - Expand receivings data in the response, instead of accessing directly via a URL (comma separated list). See resources
Holds,Instruction Recipients,Items,Shipments,labelsandTrackingsfor information on the data model returned by this parameter
Import
import ballerinax/shipwire.receivings;Metadata
Released date: 1 day ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-21 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 42
Current verison: 1
Weekly downloads
Keywords
Vendor/Shipwire
Area/ERP & Business Operations
Type/Connector
Contributors