ShipStation

ShipStation API docs: https://www.shipstation.com/docs/api/ 

Actions:

Incoming

ORDERS - Pulls orders from ShipStation

 Customer Name: Returns orders that match the specified name. 

Item Keyword: Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options. 

Days to Check Max: The maximum number of days to look back for orders.

Days to Check Min: The minimum number of days to look back for orders.

• Create: Looks back using createDate

• Modify: Looks back using modifyDate

• Order: Looks back using orderDate

• Payment: Looks back using paymentDate

For example, a transport with Create Days to Check Max = 28 and Create Days to check Min = 5 looks for orders created 5-28 days ago.

Customs Country Code: The default two-letter ISO Origin Country code for the Product. 

Order Number: Filter by order number, performs a "starts with" search. 

Order Status: Filter by order status. If left empty, orders of all statuses are returned.

Values:

• awaiting_payment

• awaiting_shipment

• pending_fulfillment

• shipped

• on_hold

• cancelled

• rejected_fulfillment

Store ID: Filters orders to a single, identified store. 

Sort By: Sort the responses by a set value.

Values:

• OrderDate

• ModifyDate

• CreateDate

Sort Direction: Sets the direction of the sort order.

Values:

ASC

DESC

Max Orders Per page: Default value is 500. Decreasing this increases the number of API calls made.

        SHIPMENTS - Pulls shipments from ShipStation. Each shipment becomes its own Crossfire message. Already-pulled shipments are tracked in the local ShipStationObject cache so           they aren't re-sent.

                Days to Check Max: The maximum number of days to look back (createDate) for shipments.

                Days to Check Min: The minimum number of days to look back (createDate) for shipments.

                        For example, a transport with Create Days to Check Max = 28 and Create Days to Check Min = 5 looks for shipments created 5-28 days ago.

                Order Number: Filter by order number, performs a "starts with" search.

                Store ID: Filters shipments to a single, identified store.

                Sort By: Sort the responses by a set value.

                        Values:

                                ShipDate

                                CreateDate

                                ModifyDate

                Sort Direction: Sets the direction of the sort order.

                        Values:

                                ASC

                                DESC

                Max Orders Per Page: Default value is 500. Decreasing this increases the number of API calls made.

Outgoing

MARKASSHIPPED - Marks an order in shipstation as shipped. Creates a fulfillment with the tracking number and carrier code. Set notifySalesChannels=true for shopify integration to work.

Message Standard

<OutgoingMarkAsShippedMessage>

<OrderNumber>{Order Number without leading #}</OrderNumber>

<CarrierCode>{Carrier Code from Carriers resource}</CarrierCode>

<ShipDate/>{Will default to today if left empty}

<TrackingNumber>{Tracking Number}</TrackingNumber>

<NotifyCustomer>false</NotifyCustomer>

<NotifySalesChannel>{Set to true for shopify integration}</NotifySalesChannel>

</OutgoingMarkAsShippedMessage>

GETRATES - Gets available shipping rates from ShipStation for a parcel. The returned rate list is sent back to Crossfire as a response message addressed to ResponseDeliveryTypeDetail, with an attachment named 

Response_GetRates_{messageId}.xml.

                Settings

                        Response Delivery Type Detail: SystemName of the Crossfire transport to send the response message to. If left blank, the response is silently skipped.

                Message Standard

        <OutgoingGetRatesMessage>

                <CarrierCode>{Carrier Code from Carriers resource}</CarrierCode>

                <ServiceCode>{Service Code, optional}</ServiceCode>

                <PackageCode>{Package Code, optional}</PackageCode>

                <FromPostalCode>{Origin Postal Code}</FromPostalCode>

                <ToState>{Destination State, optional}</ToState>

                <ToCountry>{Destination Country, two-letter ISO}</ToCountry>

                <ToPostalCode>{Destination Postal Code}</ToPostalCode>

                <ToCity>{Destination City, optional}</ToCity>

                <WeightValue>{Decimal}</WeightValue>

                <WeightUnits>{ounces|pounds|grams|kilograms}</WeightUnits>

                <DimensionsLength>{Decimal, optional}</DimensionsLength>

                <DimensionsWidth>{Decimal, optional}</DimensionsWidth>

                <DimensionsHeight>{Decimal, optional}</DimensionsHeight>

                <DimensionsUnits>{inches|centimeters, optional}</DimensionsUnits>

                <Confirmation>{none|delivery|signature|adult_signature|direct_signature, optional}</Confirmation>

                <Residential>{true|false, optional}</Residential>

        </OutgoingGetRatesMessage>

        CREATELABEL - Creates a shipping label in ShipStation by calling shipments/createlabel. The resulting ShipmentId is logged. No response is sent back to Crossfire.

                Message Standard

        <OutgoingCreateLabelMessage>

                <CarrierCode>{Carrier Code from Carriers resource}</CarrierCode>

                <ServiceCode>{Service Code}</ServiceCode>

                <PackageCode>{Package Code}</PackageCode>

                <Confirmation>{none|delivery|signature|adult_signature|direct_signature, optional}</Confirmation>

                <ShipDate>{YYYY-MM-DD, defaults to today if empty}</ShipDate>

                <TestLabel>{true|false - true returns a sample label without charging}</TestLabel>

                <WeightValue>{Decimal}</WeightValue>

                <WeightUnits>{ounces|pounds|grams|kilograms}</WeightUnits>

                <DimensionsLength>{Decimal, optional}</DimensionsLength>

                <DimensionsWidth>{Decimal, optional}</DimensionsWidth>

                <DimensionsHeight>{Decimal, optional}</DimensionsHeight>

                <DimensionsUnits>{inches|centimeters, optional}</DimensionsUnits>

                <ShipFromName>{Name}</ShipFromName>

                <ShipFromCompany>{Company, optional}</ShipFromCompany>

                <ShipFromStreet1>{Street 1}</ShipFromStreet1>

                <ShipFromStreet2>{Street 2, optional}</ShipFromStreet2>

                <ShipFromStreet3>{Street 3, optional}</ShipFromStreet3>

                <ShipFromCity>{City}</ShipFromCity>

                <ShipFromState>{State}</ShipFromState>

                <ShipFromPostalCode>{Postal Code}</ShipFromPostalCode>

                <ShipFromCountry>{Two-letter ISO Country code}</ShipFromCountry>

                <ShipFromPhone>{Phone, optional}</ShipFromPhone>

                <ShipFromResidential>{true|false, optional}</ShipFromResidential>

                <ShipToName>{Name}</ShipToName>

                <ShipToCompany>{Company, optional}</ShipToCompany>

                <ShipToStreet1>{Street 1}</ShipToStreet1>

                <ShipToStreet2>{Street 2, optional}</ShipToStreet2>

                <ShipToStreet3>{Street 3, optional}</ShipToStreet3>

                <ShipToCity>{City}</ShipToCity>

                <ShipToState>{State}</ShipToState>

                <ShipToPostalCode>{Postal Code}</ShipToPostalCode>

                <ShipToCountry>{Two-letter ISO Country code}</ShipToCountry>

                <ShipToPhone>{Phone, optional}</ShipToPhone>

                <ShipToResidential>{true|false, optional}</ShipToResidential>

        </OutgoingCreateLabelMessage>