Page tree
Skip to end of metadata
Go to start of metadata

An OrderImport message is used to place one or more orders.


The following URL and parameters are used in an OrderImport request:  

URLhttps://<service_domain>/service/opentools/OrderImport/<ProjectID>/jp.jws
ParametersNameTypeRequiredDescription
requestIdStringYUnique message identifier
sourceSystemIdStringYSystem initiating message (MessageDestination.providerCode)
destinationSystemIdStringY

EDGE Merchant identifier (MessageDestination.xRefMerchantId)

ordersObject ArrayYArray of orders to be imported
• externalReferenceStringNAn external reference to this order
• referenceFieldsString ArrayN

Array of additional references to this order

Max length: 5

• createDateTimeStringNDate and time in ISO 8601 format of when the order was placed
• releaseDateStringNDate  in ISO 8601 format of when the order should be released to the WMS
• currencyStringY

The currency used for this order.

Possible values: "AED", "ALL", "ARS", "AUD", "BAM", "BGN", "BHD", "BOB", "BRL", "BYN", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "DZD", "EGP", "EUR", "GBP", "GTQ", "HKD", "HNL", "HRK", "HUF", "IDR", "ILS", "INR", "IQD", "ISK", "JOD", "JPY", "KRW", "KWD", "LBP", "LTL", "LVL", "LYD", "MAD", "MKD", "MXN", "MYR", "NIO", "NOK", "NZD", "OMR", "PAB", "PEN", "PHP", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SDG", "SEK", "SGD", "SVC", "SYP", "THB", "TND", "TRY", "TWD", "UAH", "USD", "UYU", "VEF", "VND", "YER", "ZAR"

• localeStringY

The locale associated with this order

Possible values: "ar_AE", "ar_BH", "ar_DZ", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SD", "ar_SY", "ar_TN", "ar_YE", "be_BY", "bg_BG", "ca_ES", "cs_CZ", "da_DK", "de_AT", "de_CH", "de_DE", "de_LU", "el_CY", "el_GR", "en_AU", "en_CA", "en_GB", "en_IE", "en_IN", "en_MT", "en_NZ", "en_PH", "en_SG", "en_US", "en_ZA", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_ES", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PE", "es_PR", "es_PY", "es_SV", "es_US", "es_UY", "es_VE", "et_EE", "fi_FI", "fr_BE", "fr_CA", "fr_CH", "fr_FR", "fr_LU", "ga_IE", "he_IL", "hi_IN", "hr_HR", "hu_HU", "id_ID", "is_IS", "it_CH", "it_IT", "ja_JP", "ko_KR", "lt_LT", "lv_LV", "mk_MK", "ms_MY", "mt_MT", "nl_BE", "nl_NL", "nn_NO", "no_NO", "pl_PL", "pt_BR", "pt_PT", "ro_RO", "ru_RU", "sk_SK", "sl_SI", "sq_AL", "sr_BA", "sr_Latn_BA", "sr_Latn_ME", "sr_ME", "sr_RS", "sv_SE", "th_TH", "tr_TR", "uk_UA", "vi_VN", "zh_CN", "zh_HK", "zh_SG", "zh_TW"

• shipComplete
BooleanN

true = the order can only be shipped with a single shipment group

false (default) = the order may be partially shipped

• notes
StringNNotes to be attached to the order
• sourceStringN

The Marketing Source code to be associated with this order

Defined in EDGE>Campaigns

• billingCodeStringN

The Billing Code name to be associated with this order

Defined in EDGE>System Admin>Merchant>Billing Codes

• promotionsArray of StringN

Promotion codes to apply towards this order.

Defined in EDGE>Promotions/Rules

• customerObjectYContains information about the customer
• • userNameStringN

The customer's username

• • phoneNumbersString ArrayN

Array of phone numbers associated with the billing address

Max length: 6

• • emailStringYThe email address associated with the billing address
• • memberTypeStringN

This customer's Member Type code

Defined in EDGE>System Admin>Customer>Member Types

• • addressObjectYContains billing address information
• • • firstNameStringYThe first name of the person associated with the billing address
• • • lastNameStringYThe last name of the person associated with the billing address
• • • middleNameStringNThe middle name of the person associated with the billing address
• • • organizationStringNCompany name 
• • • address1StringYFirst part of billing address
• • • address2StringNSecond part of billing address
• • • cityStringYName of city
• • • stateProvinceStringNThe state or province code
• • • postalCodeStringYThe postal code
• • • countryCodeStringYThe country code
• • • isResidentialBooleanN

true (default) = address is residential

false = address is not residential

• autoshipObjectN

Container for autoship data.

Note:

  • These autoship-related parameters are reserved for use by Jagged Peak support and Professional Services teams only.
  • Refer to Autoship Related Project Settings for related informaton.
• • numberNumberYAutoship sequential number (1,2,3,etc)
• • templateIdNumberYAutoship template Id (AutoshipOrderHeaderId)
• • interceptorStringNInterceptor name for autoship order
• • paymentsObject ArrayYArray of objects containing payment information
• • • paymentTypeStringY

The payment type for this payment object

Possible values: "CC", "PONUMBER", "ECHECK", "GC", "GIFT_CERTIFICATE", "BILL_ME", "MEMBER_BUDGET", "COD", "CASH", "BUDGET_CENTER", "CHARGES_WAIVED", "CHECKOUT".

• • • transactionTypeStringN

The transaction type for this payment object. Used when payment was processed outside of EDGE and the transaction needs to be stored.

Possible values: "AUTH_CAPTURE", "AUTH_ONLY", "PRIOR_AUTH_CAPTURE", "CREDIT", "CANCEL", "CREATE_TOKEN_PROFILE", "DELETE_TOKEN_PROFILE", "ACTIVATE", "REACTIVATE", "RELOAD", "DEACTIVATE", "BALANCE", "REFUND", "RETURN", "INITIATE", "DETAILS".

• • • paymentStatusStringN

The status of the payment. Used when payment was processed outside of EDGE and the transaction needs to be stored.

Possible values: "completed", "pending", "failed", "denied", "refunded", "canceled", "authentication", "saved"

• • • authorizerCodeStringNThe payment authorizer code used to process this payment. Used when the payment was processed outside of EDGE and the transaction needs to be stored.
• • • amountNumberYAmount for this payment to process.
• • • transactionIdStringNThe transaction ID for this payment. Used when the payment was processed outside of EDGE and the transaction needs to be stored.
• • • cardNumberStringN

The card number for this payment. Valid for payment types "CC" and "GC".
Value passed should be encrypted using the API call described at EncryptString.
(Description is provided in the Example tab.)

• • • cardSuffixStringN

The credit card suffix for this payment

Valid for payment type "CC"

• • • cardPinStringNThe gift card's PIN. Valid for payment type "GC". 
Value passed should be encrypted using the API call described at EncryptString.
(Description is provided in the Example tab.)
• • • cardTypeStringN

The credit card type

Valid for payment type "CC"

• • • expirationMonthNumberN

Expiration date month as shown on the credit card

Valid for payment type "CC"

• • • expirationYearNumberN

Expiration date year as shown on the credit card

Valid for payment type "CC"

• • • paymentTokenStringNThe payment token used to process the payment
• • • profileTokenStringNThe profile token used to process payment
• • • paymentDateTimeStringN

Date and time when the payment was processed. Used when the payment was processed outside of EDGE and the transaction needs to be stored.

ISO 8601 format

• • • responseCodeStringNThe payment process response code given by the payment authorizer. Used when the payment was processed outside of EDGE and the transaction needs to be stored.
• • • responseTextStringNThe payment process response message given by the payment authorizer. Used when the payment was processed outside of EDGE and the transaction needs to be stored
• shippingInfoObject Y

Object containing shipping and fulfillment information

• • carrierStringYCarrier name (UPS, USPS, etc) 
• • serviceStringY

Ship method code for this shipping info block.

Defined in EDGE>Logistics

• • providerStringN

Code for the provider who will fulfill the lines associated with this shipping info block

Defined in EDGE>Logistics

• • notesStringNNotes/comments for shipments using this shipping information
• • deliveryDateStringN

Date when the shipment should arrive

ISO 8601

• • addressObjectYContains information about shipping address
• • • firstNameStringYThe first name of the person associated with the shipping address
• • • lastNameStringYThe last name of the person associated with the shipping address
• • • middleNameStringNThe middle name of the person associated with the shipping address
• • • organizationStringNCompany name 
• • • address1StringYFirst part of the shipping address
• • • address2StringNSecond part of the shipping address
• • • cityStringYCity name
• • • stateProvinceStringNThe state or province code
• • • postalCodeStringYThe postal code
• • • countryCodeStringYThe country code
• • • isResidentialBooleanN

true (default) = address is residential

false = address is not residential

• • chargeObjectNContains information about shipping charges
• • • priceNumberNOriginal shipping and handling price 
• • • discountNumberNDiscount provided for shipping and handling 
• • • amountNumberYTotal shipping and handling amount including taxes 
• • • taxObjectNContainer for taxes/tax-related information
• • • • amountNumberYTotal tax amount  
• • • • jurisdictionsArray of ObjectNTax break down by jurisdictions 
• • • • • nameStringN

Name of the tax jurisdiction.

Possible values" "StateSalesTax", "CountySalesTax", "CitySalesTax", "GoodsAndServicesTax", "ProvincialSalesTax", "DistrictSalesTax", "ApoSalesTax", "BoroughSalesTax", "CountrySalesTax", "FpoSalesTax", "LocalImprovementDistrictSalesTax", "ParishSalesTax", "SpecialPurposeDistrictSalesTax", "TerritorySalesTax", "TownshipSalesTax", "TradeBlockSalesTax", "TransitDistrictSalesTax", "SpecialSalesTax", "CompositeSalesTax".

 
• • • • • rateNumberNTax rate for this jurisdication
• • • • • amountNumberYTotal tax amount  
• itemsObject ArrayYArray of objects containing cart line details
• • catalogStringYCatalog item number value of ordered product
• • skuStringYSKU value of ordered product
• • quantityNumberYQuantity of ordered product
• • chargeObjectNContains information of item charges
• • • priceNumberNOriginal item price 
• • • discountNumberNDiscount provided for the item 
• • • amountNumberYTotal amount including taxes 
• • • taxObjectNContainer for taxes
• • • • amountNumberYTotal tax amount  
• • • • jurisdictionsArray of ObjectNTax break down by jurisdictions 
• • • • • nameStringN

Name of the tax jurisdiction

Possible values" "StateSalesTax", "CountySalesTax", "CitySalesTax", "GoodsAndServicesTax", "ProvincialSalesTax", "DistrictSalesTax", "ApoSalesTax", "BoroughSalesTax", "CountrySalesTax", "FpoSalesTax", "LocalImprovementDistrictSalesTax", "ParishSalesTax", "SpecialPurposeDistrictSalesTax", "TerritorySalesTax", "TownshipSalesTax", "TradeBlockSalesTax", "TransitDistrictSalesTax", "SpecialSalesTax", "CompositeSalesTax".

 
• • • • • rateNumberNTax rate for this jurisdication
• • • • • amountNumberYTotal tax amount  
• • extensionsObjectNArray of extensions on item level (order line dynamic fields)
• • • codeStringYExtension code 
• • • valueStringYExtension value
•  extensionsObjectNArray of extensions on order level (order header dynamic fields)
• • codeStringYExtension code 
• • valueStringYExtension value

The following parameters are used in an OrderImport response:

ParametersNameTypeDescription
resultCodeStringOK or FAIL
resultMessageStringError description when the request fails

Possible value: "Missing one or more required parameters."

The following are examples of the request, XML mapping and responses for the OrderImport message.

POST https://rdqaint-services.jaggedpeak.com/opentools/OrderImport/4/jp.jws

Click  for an example of this request in JSON format.

Click for the XML mapping for this example request.

Click  for an example of a successful response in JSON format.

Click  for an example of a failed response in JSON format.

EncryptString can be used to encrypt the cardNumber and cardPin parameters.

The following parameter is used in an EncryptString request:

URL{Services-URL}/cipher/EncryptString/{ProjectID}
ParametersNameTypeDescription
valueStringValue to be encrypted

The following parameters are used in an EncryptString response:

Parameter NameTypeDescription
value

String

Encrypted value
resultCode

String

Possible values: OK, FAIL

Represents success or failure for request
resultMessageStringAn error description for FAIL results, empty string if success
  • https://rdqaint-services.jaggedpeak.com/cipher/EncryptString/4
    Click  for an example of an EncryptString request in JSON format.

  • Click  for an example of a successful EncryptString response in JSON format.

  • Click  for an example of a failed EncryptString response in JSON format.




Tip for all examples:

For best results, hover the cursor over the "JSON" or "XML" button and click your right mouse button (or equivalent laptop button or mobile device control), then select Open link in New Window in the shortcut menu. (When prompted, select to either open the file or save the file, as preferred.)




  • No labels