Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 70 Current »

Parts Ordering Response Object Formats

JSON Format
{
	"Orders": [{
		"EstimatedDelivery": "2014-12-18T10:00:00.000Z",
		"PartOrderNum": "",
		"Parts": [{
			"ProdNum": "",
			"PartStatus": "{free text}",
			"ProdAttrs": {
				"Desc": "",
				"IsBatch": false,
				"IsInvCtrl": false,
				"IsSerialized": false,
				"Price": 0.0,
				"ProdType": "1001"
			},
			"ShipToLocation": "",
			"SupersededParts": [{
				"ProdNum": "",
				"PartStatus": "{free text}",
				"ProdAttrs": {
					"Desc": "",
					"IsBatch": false,
					"IsInvCtrl": false,
					"IsSerialized": false,
					"Price": 0.0,
					"ProdType": "1001"
				},
				"Qty": 10.0
			}],
			"Urgency": ""
		}],
		"TrackingNumber": ""
	}],
	"Status": "",
	"StatusMsg": ""
}

Parts Ordering Response Object Properties

PropertyTypeDescription
Orderscollection
Contains a collection of one or more orders. Based on the parts being ordered, the back-end may decide to break up the order into multiple deliveries.
PropertyTypeDescription
EstimatedDeliverydatetimeThis optional field contain the estimated delivery date for the specific order.
PartOrderNumstring

Contains the order number associated with the parts order. This is a back-end generated number.

Partsobject

Contains the list of parts associated with the order.

PropertyTypeDescription

ProdNum

stringThe product number of the ordered part.
PartStatusstring

Specifies the status of ordered part. This is a simple free-form text field with no validation.

3.18.0

ProdAttrsobject

Product attributes of the ordered part.

See: Product Object

3.18.0

Qty

decimalThe quantity being ordered.
ShipToLocationstring

Optional property that identifies the location where the ordered part will be shipped to.

3.18.0 3.37.0

SupersededPartscollection

This optional collection contains a list of parts that replaces the ordered part.

Property

Type

Description

ProdNumstringThe product number of the replacement part.
PartStatusstring

Specifies the status of replacement part. This is a simple free-form text field with no validation.

ProdAttrsobject

Product attributes of the ordered part.

See: Product Object

QtydecimalThe quantity being ordered.

3.18.0

Urgencystring

Optional property that identifies the shipping urgency for the ordered parts.

3.18.1 3.37.0


TrackingNumberstring

Contains the shipping tracking number.

Statusstring

This field contains the status of the parts order request.

Valid values are:

  • 0 - OK
  • 1001 - Parts Ordering system is unavailable
  • 2001 - Error in request body
  • 3001 - Parts unavailable at this time
  • 3002 - Can’t cancel, parts have shipped
  • 3003 - Parts no longer available
StatusMsgstring

This optional field contains additional human readable text related to the returned Status. For example, if the Status value is 2001, if would be beneficial if the back-end system returned the error it detected in readable format.

  • No labels